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

Fixing blacken-docs error messages #551

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

Schefflera-Arboricola
Copy link
Contributor

@Schefflera-Arboricola Schefflera-Arboricola commented Dec 24, 2024

Description

Kindly take a look at CONTRIBUTING.md.

Please describe the purpose of this pull request. Reference and link to any relevant issues or pull requests.

closes #240

Note for reviewer

Reviewing this PR commit-wise might be easier.

Checklist

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't any other open Pull Requests for the required change?
  • Does your submission pass pre-commit? ($ pre-commit run --all-files or $ nox -s lint)
  • Does your submission pass tests? ($ pytest or $ nox -s tests)
  • Does the documentation build with your changes? ($ cd docs; make clean; make html or $ nox -s docs)
  • Does your submission pass the doctests? ($ pytest --doctest-plus src/vector/ or $ nox -s doctests)

Before Merging

  • Summarize the commit messages into a brief review of the Pull request.

@@ -781,11 +781,14 @@ def transform2D(self: SameVectorType, obj: TransformProtocol2D) -> SameVectorTyp
"""
Arbitrarily transforms the vector(s) by

.. blacken-docs:off
Copy link
Contributor Author

Choose a reason for hiding this comment

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

To maintain consistency in the _methods.py file, I have used .. blacken-docs:off/on here instead of replacing python with pycon. LMKWYT.

@Schefflera-Arboricola Schefflera-Arboricola marked this pull request as ready for review December 30, 2024 10:42
Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

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

Thanks for looking into this, @Schefflera-Arboricola!

I would be happy with this, or with @jpivarski's solution of closing the issue without any modifications (as now this is the "dev" docstrings).

I would let @jpivarski decide whichever is better!

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.

Make code blocks in src/vector/_compute/*.py parsable
2 participants