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

Pull Changes from develop for documentation updates #4

Merged
merged 9 commits into from
Sep 18, 2024
Merged

Conversation

mhogan-nwra
Copy link
Owner

Topic

Add documentation updates that reflect the intended use cases and migration to envector from nvector.

Steps

  1. Include an example for use

No changes to the API were introduced.

  1. Add a note to CHANGELOG.rst about the changes

I do not believe this is required. The last item in version 0.3.1 explains enough.

Expand documentation on the reasons for the existence of envector.

  1. Update the author list in AUTHORS.rst if applicable

Not necessary

  1. Ensure that all checks passed (current checks include GitHub Actions)

Ran nox and all versions (3.9 - 3.12) passed.

@mhogan-nwra
Copy link
Owner Author

Decision

This pull request has been accepted and will be merged.

Reason

All GitHub Actions CI passed and no merge conflicts are present.

@mhogan-nwra mhogan-nwra merged commit ceecbbd into main Sep 18, 2024
12 checks passed
@mhogan-nwra mhogan-nwra deleted the develop branch September 18, 2024 19:45
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.

1 participant