Skip to content

Documentation refactor + nitpicky + example review + chaos#318

Merged
nabobalis merged 19 commits intomainfrom
docs
May 11, 2024
Merged

Documentation refactor + nitpicky + example review + chaos#318
nabobalis merged 19 commits intomainfrom
docs

Conversation

@nabobalis
Copy link
Member

@nabobalis nabobalis commented Nov 2, 2023

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
Copy link

codecov bot commented Nov 2, 2023

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.

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
Co-authored-by: Will Barnes <will.t.barnes@gmail.com>
Co-authored-by: Will Barnes <will.t.barnes@gmail.com>
Co-authored-by: Will Barnes <will.t.barnes@gmail.com>
Co-authored-by: Will Barnes <will.t.barnes@gmail.com>
@nabobalis
Copy link
Member 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 requested a review from wtbarnes December 20, 2023 17:43
@nabobalis nabobalis requested a review from wtbarnes January 5, 2024 00:11
@nabobalis nabobalis force-pushed the docs branch 3 times, most recently from b24391b to 76d7d00 Compare May 11, 2024 00:04
@nabobalis nabobalis merged commit ae48fd4 into main May 11, 2024
@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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants