Skip to content

Fix documentation and GitHub Actions workflow syntax#122

Merged
skyelaird merged 1 commit intomainfrom
claude/fix-docs-workflow-yaml-012soA2Us4JydAN9nMM4CSUC
Nov 18, 2025
Merged

Fix documentation and GitHub Actions workflow syntax#122
skyelaird merged 1 commit intomainfrom
claude/fix-docs-workflow-yaml-012soA2Us4JydAN9nMM4CSUC

Conversation

@skyelaird
Copy link
Copy Markdown
Owner

@skyelaird skyelaird commented Nov 18, 2025

YAML Fix:

  • Fixed syntax error on line 79 in .github/workflows/validation.yml
  • Changed Python script quotes from double to single to avoid YAML parsing issues
  • Properly escaped inner quotes in f-strings

Documentation Consistency Updates:

  • Updated Python version requirement to 3.11+ across all docs (README, wiki)
  • Fixed class name inconsistency (GeographicPoint → IonoPoint) in examples
  • Updated validation pass rate from 83.8% to 86.6% across all documentation
  • Updated performance metrics to reflect v1.0.1 optimizations (2.3x speedup)
  • Fixed version references from v1.0.0 to v1.0.1 where applicable
  • Updated PyPI status to reflect production-ready v1.0.1

Files Modified:

  • .github/workflows/validation.yml - YAML syntax fix
  • wiki/Getting-Started.md - Python version, class name, examples
  • wiki/Known-Issues.md - Performance metrics, version footer
  • wiki/FAQ.md - Python version, validation rates, performance data
  • NEXT_STEPS.md - Validation rates, timestamps, status updates

All documentation now consistent with v1.0.1 production release status.

Description

A clear and concise description of what this PR does.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Performance improvement
  • Code refactoring
  • Test coverage improvement

Related Issues

Closes #(issue number)
Related to #(issue number)

Changes Made

  • Change 1
  • Change 2
  • Change 3

Testing

Describe the tests you've run to verify your changes:

Test Configuration

  • Python version:
  • Operating System:
  • NumPy/SciPy versions:

Test Results

# Command used to test
python -m pytest tests/

# Or validation command
python test_voacap_reference.py
  • All existing tests pass
  • New tests added for new functionality
  • Validation pass rate maintained or improved
  • No performance regression

Validation Checklist

  • Code follows PEP 8 style guidelines
  • Docstrings added/updated for public functions
  • Type hints added where appropriate
  • Comments added for complex logic
  • Documentation updated (README, USAGE, etc.)
  • CHANGELOG.md updated
  • No new warnings or errors introduced

Performance Impact

  • No performance impact
  • Performance improved (provide benchmarks)
  • Minor performance regression (justified because...)
  • Not applicable

Benchmarks (if applicable)

Before: X seconds
After: Y seconds
Change: Z% improvement/regression

Breaking Changes

If this PR introduces breaking changes, describe:

  1. What breaks
  2. Migration path for users
  3. Why this change is necessary

Screenshots/Output (if applicable)

For dashboard changes or output format changes, include before/after screenshots or sample output.

Additional Notes

Any additional information that reviewers should know:

  • Assumptions made
  • Trade-offs considered
  • Future work needed
  • Dependencies added/removed

Reviewer Checklist

For maintainers reviewing this PR:

  • Code quality is acceptable
  • Tests are comprehensive
  • Documentation is clear
  • Validation results are acceptable
  • No security issues introduced
  • Backward compatibility maintained (or breaking changes justified)

YAML Fix:
- Fixed syntax error on line 79 in .github/workflows/validation.yml
- Changed Python script quotes from double to single to avoid YAML parsing issues
- Properly escaped inner quotes in f-strings

Documentation Consistency Updates:
- Updated Python version requirement to 3.11+ across all docs (README, wiki)
- Fixed class name inconsistency (GeographicPoint → IonoPoint) in examples
- Updated validation pass rate from 83.8% to 86.6% across all documentation
- Updated performance metrics to reflect v1.0.1 optimizations (2.3x speedup)
- Fixed version references from v1.0.0 to v1.0.1 where applicable
- Updated PyPI status to reflect production-ready v1.0.1

Files Modified:
- .github/workflows/validation.yml - YAML syntax fix
- wiki/Getting-Started.md - Python version, class name, examples
- wiki/Known-Issues.md - Performance metrics, version footer
- wiki/FAQ.md - Python version, validation rates, performance data
- NEXT_STEPS.md - Validation rates, timestamps, status updates

All documentation now consistent with v1.0.1 production release status.
@skyelaird skyelaird merged commit f944389 into main Nov 18, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants