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.

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

NRL pub release #118

Merged
merged 14 commits into from Apr 25, 2024
Merged

NRL pub release #118

merged 14 commits into from Apr 25, 2024

Conversation

aburrell
Copy link
Member

@aburrell aburrell commented Apr 23, 2024

Description

Addresses #117 and #116.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How Has This Been Tested?

Created docs locally and addressed warnings.

Test Configuration

  • Operating system: OS X Big Sur
  • Version number: Python 3.9
  • Any details about your local setup that are relevant: develop branch of pysat

Checklist:

  • Make sure you are merging into the develop (not main) branch
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • Add a note to CHANGELOG.md, summarizing the changes
  • Update zenodo.json file for new code contributors

If this is a release PR, replace the first item of the above checklist with the
release checklist on the pysat wiki:
https://github.com/pysat/pysat/wiki/Checklist-for-Release

Added funding acknowledgements to the repository and documentation.
Added a summary of changes to the changelog.
Updated the main repository init header.
Updated the instrument headers with the NRL pub release.
Updated the Instrument methods headers with the NRL pub release statement.
Updated the methods headers with the NRL pub release statement and improved the docstrings.
Updated the headers for the unit test files, improved the docstrings, and updated some comments.
Updated the utils headers to include the NRL pub release.
Updated the docstrings to remove formatting characters and fixed lines that were too long for PEP8.
Remove extra lines and capitalize planet's name.
Improved spacing in the documentation, line length in the readme, and added a
link to the full package documentation in the documentation section of the
readme.
Removed the extra "poweredbypysat" figure from the main directory.
Removed trailing whitespace from the docstring.
Added a yaml for ReadTheDocs.
@aburrell aburrell added this to the 0.3.5 Release milestone Apr 23, 2024
@aburrell aburrell added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request and removed enhancement New feature or request labels Apr 23, 2024
@aburrell aburrell requested a review from jklenzing April 23, 2024 16:05
@aburrell aburrell merged commit 647def0 into develop Apr 25, 2024
21 checks passed
@aburrell aburrell deleted the nrl_pub_release branch April 25, 2024 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants