Skip to content

Add docstrings throughout #80

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 4, 2023
Merged

Add docstrings throughout #80

merged 2 commits into from
May 4, 2023

Conversation

dstansby
Copy link
Member

@dstansby dstansby commented May 3, 2023

This:

  • Adds pydocstyle ("D") to the list of ruff checks. Among other things, this makes sure all public API has a docstring.
  • Adds remaining missing docstrings across the package.

Fixes #68

@dstansby dstansby marked this pull request as ready for review May 3, 2023 11:22
@dstansby dstansby requested review from samcunliffe and ruaridhg May 3, 2023 11:22
samcunliffe
samcunliffe previously approved these changes May 3, 2023
View reviewed changes
@dstansby @samcunliffe
Add missing capital
d3785ee 
Co-authored-by: Sam Cunliffe <samcunliffe@users.noreply.github.com>
@dstansby dstansby enabled auto-merge May 4, 2023 13:36
@dstansby dstansby requested a review from samcunliffe May 4, 2023 13:41
ruaridhg
ruaridhg approved these changes May 4, 2023
View reviewed changes
Copy link
Collaborator

@ruaridhg ruaridhg 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 to me.

@dstansby dstansby added this pull request to the merge queue May 4, 2023
Merged via the queue into matplotlib:main with commit 20f423e May 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ruaridhg ruaridhg ruaridhg approved these changes

@samcunliffe samcunliffe Awaiting requested review from samcunliffe

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add docstrings across the package
3 participants
@dstansby @samcunliffe @ruaridhg