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

MAINT: Update templates #95

Merged
merged 17 commits into from
Sep 18, 2023
Merged

MAINT: Update templates #95

merged 17 commits into from
Sep 18, 2023

Conversation

aburrell
Copy link
Member

@aburrell aburrell commented Sep 14, 2023

Description

Addresses #78 by updating tests, documents, and adding a pyproject.toml.

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality or documentation)
  • This change requires a documentation update

How Has This Been Tested?

Built docs locally.

Test Configuration

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

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 linted the files updated in this pull request
  • 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

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

Fixed typos in the issue templates.
Added new item for the PR checklist.
Updated the test yamls to use pyproject.toml and cycle the version support.
Added a readthedocs yaml.
Added missing section to the code of conduct.
Fixed format and updated style requirements in the contributing guidelines.
Replaced the setup.py with pyproject.toml.
Fixed broken links and updated dependencies in the README.
Updated the version support to use pyproject.toml.
Added a summary of the changes to the changelog.
Fixed matrix variables so that new if statement is triggered.
Updated version access in conf.py.
Removed duplicate explicit links.
Included a missing example in the example index.
Removed comma from authors.
Update the installation guide to reflect the change to pyproject.toml.
@aburrell aburrell added this to the 0.2.0 Release milestone Sep 14, 2023
@aburrell aburrell added the documentation Improvements or additions to documentation label Sep 14, 2023
@aburrell aburrell linked an issue Sep 14, 2023 that may be closed by this pull request
2 tasks
@aburrell
Copy link
Member Author

Decrease in coverage due to a reduction in lines in the top-level __init__.py file.

Removed the old version.txt file from the manifest.
Copy link
Member

@jklenzing jklenzing left a comment

Choose a reason for hiding this comment

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

Looks good. Failing tests a result of the download failure issue.

@aburrell aburrell merged commit 62ee8ff into develop Sep 18, 2023
19 of 21 checks passed
@aburrell aburrell deleted the update_templates branch September 18, 2023 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Check standard docs for pysatMadrigal
2 participants