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

Ruff docs #174

Merged
merged 1 commit into from
Sep 28, 2023
Merged

Conversation

greglucas
Copy link
Collaborator

Change Summary

NOTE: This is a proposal. Do we want to follow all of these conventions? Are some of these too annoying and will make too much noise and therefore we should ignore them? I went through and made the changes I thought made sense for now and they didn't seem too bad, and it is better to start these checks sooner rather than later IMO.

Overview

Add numpydoc conventions to our continuous integration setup to
start enforcing documentation standards.

Have chosen to ignore module-level and package-level docstrings
for now. We can add those rules later if we want. We also ignore
these for the tools and tests directory, which can be added later
as well if we think they are needed.

Updated Files

Many, I updated the docstrings to meet the ruff enforced standards.

Testing

Ignored docstrings in our tests directory.

@greglucas greglucas added the Repo: Documentation Improvements or additions to documentation label Sep 27, 2023
@greglucas greglucas requested review from a team, bourque, sdhoyt, tech3371, bryan-harter, laspsandoval, GFMoraga and maxinelasp and removed request for a team September 27, 2023 19:58
Copy link
Contributor

@maxinelasp maxinelasp left a comment

Choose a reason for hiding this comment

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

I think the changes you had to make show that we are already using this basic style in our documentation. I think it's a good thing to add to the pre commit.

Copy link
Collaborator

@bourque bourque left a comment

Choose a reason for hiding this comment

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

I like all of these changes, and I am for enforcing these moving forward.

I think I would also be good with module-level enforcement too.

Copy link
Contributor

@sdhoyt sdhoyt left a comment

Choose a reason for hiding this comment

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

I agree. I think it would be good to add this to the checks.

Use numpy doc conventions, which disables some doc conventions we
were already ignoring.

DOC: Add documentation checks to ruff

Add numpydoc conventions to our continuous integration setup to
start enforcing documentation standards.

Have chosen to ignore module-level and package-level docstrings
for now. We can add those rules in later if we want. We also ignore
these for the tools and tests directory, which can be added later
as well if we think they are needed.
@greglucas
Copy link
Collaborator Author

Since we seem to have a consensus on this. I'm going to merge because there are going to be minor merge conflicts coming up with all the PRs and I'd like to push those on to everyone else so you all can update the docstrings in your own words and I don't have to infer what you want!

@greglucas greglucas merged commit e2d3eb3 into IMAP-Science-Operations-Center:dev Sep 28, 2023
12 checks passed
@greglucas greglucas deleted the ruff-docs branch September 28, 2023 15:40
laspsandoval pushed a commit to laspsandoval/imap_processing that referenced this pull request Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Repo: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants