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.

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

Rework docstrings to the Sphinx style #458

Merged
merged 1 commit into from
Jan 13, 2023
Merged

Rework docstrings to the Sphinx style #458

merged 1 commit into from
Jan 13, 2023

Conversation

PerchunPak
Copy link
Member

I want to merge this into master, so it will not produce many merge conflicts in possible future.

ItsDrike
ItsDrike requested changes Jan 8, 2023
View reviewed changes
Copy link
Member

@ItsDrike ItsDrike left a comment

Choose a reason for hiding this comment

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

I'd like to see an extension like flake8-docstrings added too, so that there's something enforcing the proper docstring format is followed.

mcstatus/address.py Outdated Show resolved Hide resolved
mcstatus/protocol/connection.py Outdated Show resolved Hide resolved
mcstatus/utils.py Outdated Show resolved Hide resolved
@PerchunPak
Copy link
Member Author

I'd like to see an extension like flake8-docstrings added too, so that there's something enforcing the proper docstring format is followed.

It will be in the next PR, this just fixes issues like using one ` instead of two.

@PerchunPak PerchunPak force-pushed the rework-docstrings-to-sphinx-style branch 2 times, most recently from bb194c2 to 405901f Compare January 8, 2023 18:03
ItsDrike
ItsDrike approved these changes Jan 8, 2023
View reviewed changes
Copy link
Member

@ItsDrike ItsDrike left a comment

Choose a reason for hiding this comment

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

Thanks!

@ItsDrike ItsDrike added area: documentation Related to project's documentation (comments, docstrings, docs) type: enhancement Improvement to an existing feature labels Jan 10, 2023
ItsDrike
ItsDrike reviewed Jan 13, 2023
View reviewed changes
Copy link
Member

@ItsDrike ItsDrike left a comment

Choose a reason for hiding this comment

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

Would you mind also making sure that the docstrings in tests/ are consistent with this new style? While these won't be used in the docs, we shouldn't be using 2 different docstring conventions in the codebase. So if there are some, please adapt them too.

@PerchunPak PerchunPak force-pushed the rework-docstrings-to-sphinx-style branch from 405901f to b3c53ae Compare January 13, 2023 07:18
@PerchunPak
Copy link
Member Author

Would you mind also making sure that the docstrings in tests/ are consistent with this new style? While these won't be used in the docs, we shouldn't be using 2 different docstring conventions in the codebase. So if there are some, please adapt them too.

Done here!

@ItsDrike ItsDrike merged commit ceef95d into py-mine:master Jan 13, 2023
@PerchunPak PerchunPak mentioned this pull request Jan 13, 2023
Merged
@PerchunPak PerchunPak deleted the rework-docstrings-to-sphinx-style branch January 13, 2023 07:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ItsDrike ItsDrike ItsDrike approved these changes

Assignees
No one assigned
Labels
area: documentation Related to project's documentation (comments, docstrings, docs) type: enhancement Improvement to an existing feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@PerchunPak @ItsDrike