Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation refactor + nitpicky + example review + chaos #318

Merged
merged 19 commits into from
May 11, 2024
Merged

Documentation refactor + nitpicky + example review + chaos #318

merged 19 commits into from
May 11, 2024

Conversation

nabobalis
Copy link
Contributor

@nabobalis nabobalis commented Nov 2, 2023 •
edited
Loading

Aim to add more info about using aiapy and reduce any overlap with the sunpy development documentation.

TODO:

  • Work out what could be missing and fix it.

@codecov Codecov
Copy link

codecov bot commented Nov 2, 2023 •
edited
Loading

Codecov Report

Attention: Patch coverage is 71.71053% with 43 lines in your changes are missing coverage. Please review.

Project coverage is 87.09%. Comparing base (f92240a) to head (2a1011f).

Files Patch % Lines
aiapy/data/_sample.py 13.33% 26 Missing ⚠️
aiapy/data/sample.py 70.58% 5 Missing ⚠️
aiapy/conftest.py 80.00% 4 Missing ⚠️
aiapy/response/tests/test_channel.py 40.00% 3 Missing ⚠️
aiapy/util/decorators.py 60.00% 2 Missing ⚠️
aiapy/calibrate/transform.py 50.00% 1 Missing ⚠️
aiapy/psf/deconvolve.py 50.00% 1 Missing ⚠️
aiapy/version.py 80.00% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #318      +/-   ##
==========================================
- Coverage   91.03%   87.09%   -3.94%     
==========================================
  Files          35       34       -1     
  Lines        1193     1209      +16     
==========================================
- Hits         1086     1053      -33     
- Misses        107      156      +49

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nabobalis nabobalis marked this pull request as ready for review December 18, 2023 23:54
wtbarnes
wtbarnes reviewed Dec 19, 2023
View reviewed changes
docs/index.rst Outdated Show resolved Hide resolved
wtbarnes
wtbarnes reviewed Dec 19, 2023
View reviewed changes
docs/index.rst Outdated Show resolved Hide resolved
wtbarnes
wtbarnes requested changes Dec 19, 2023
View reviewed changes
Copy link
Contributor

@wtbarnes wtbarnes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting changes because I think the docs need some reorganizing.

nabobalis and others added 5 commits December 19, 2023 12:32
@nabobalis @wtbarnes
Update docs/index.rst
976706e 
Co-authored-by: Will Barnes <will.t.barnes@gmail.com>
@nabobalis @wtbarnes
Update examples/instrument_degradation.py
3be7ae1 
Co-authored-by: Will Barnes <will.t.barnes@gmail.com>
@nabobalis @wtbarnes
Update examples/instrument_degradation.py
ac9f0ea 
Co-authored-by: Will Barnes <will.t.barnes@gmail.com>
@nabobalis @wtbarnes
Update docs/index.rst
35b1efb 
Co-authored-by: Will Barnes <will.t.barnes@gmail.com>
@nabobalis
Refactored config and nitpick enable
72c9b29
@nabobalis
Copy link
Contributor Author

This PR got really out of hand.

@nabobalis nabobalis changed the title Documentation refactor Documentation refactor + nitpicky + example review + chaos Dec 19, 2023
nabobalis
nabobalis commented Dec 19, 2023
View reviewed changes
docs/getting_started.rst Outdated Show resolved Hide resolved
wtbarnes
wtbarnes requested changes Jan 4, 2024
View reviewed changes
docs/getting_started.rst Outdated Show resolved Hide resolved
docs/installation.rst Show resolved Hide resolved
docs/preparing_data.rst Outdated Show resolved Hide resolved
docs/preparing_data.rst Outdated Show resolved Hide resolved
@nabobalis nabobalis force-pushed the docs branch 3 times, most recently from b24391b to 76d7d00 Compare May 11, 2024 00:04
wtbarnes
wtbarnes approved these changes May 11, 2024
View reviewed changes
aiapy/calibrate/meta.py Outdated Show resolved Hide resolved
aiapy/data/sample.py Outdated Show resolved Hide resolved
aiapy/version.py Outdated Show resolved Hide resolved
@nabobalis nabobalis merged commit ae48fd4 into main May 11, 2024
10 of 13 checks passed
@nabobalis nabobalis deleted the docs branch May 11, 2024 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wtbarnes wtbarnes wtbarnes approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nabobalis @wtbarnes