Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

[Doc]: Document the position parameter in apply_aspect()#23617

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Closed
haziq-khurshid wants to merge1 commit intomatplotlib:mainfromhaziq-khurshid:feature-23583
Closed

[Doc]: Document the position parameter in apply_aspect()#23617

haziq-khurshid wants to merge1 commit intomatplotlib:mainfromhaziq-khurshid:feature-23583

Conversation

haziq-khurshid
Copy link
Contributor

PR Summary

This PR documents the position paramter in apply_aspect()
Issue:#23583

PR Checklist

Tests and Styling

  • [ N/A] Has pytest style unit tests (andpytest passes).
  • [ N/A] IsFlake 8 compliant (installflake8-docstrings and runflake8 --docstring-convention=all).

Documentation

  • [ N/A] New features are documented, with examples if plot related.
  • [ N/A] New features have an entry indoc/users/next_whats_new/ (follow instructions in README.rst there).
  • [ N/A] API changes documented indoc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).

@tacaswell
Copy link
Member

@haziq-khurshid Why did you close this? I think the docstring is an improvement, theParameters section just needs to go below that paragraph of prose.

@haziq-khurshid
Copy link
ContributorAuthor

@tacaswell thank you for responding.
Actually, I was trying to make my first ever open source contribution and 2 tests(ci/circleci: docs-python38 & View the built docs) were failing and I couldn't figure out a reason.
If you can guide me in the exact position of my new lines, I can place them there and make a new PR.

@tacaswell
Copy link
Member

I will reopen this PR for you, please push new commits to this branch.

It looks like there are three warnings in the build (which are different than I guessed they would be from glancing at the rst).

The first is due to.get_position being ambiguous, a number of classes have a method with that name. The solution is to add qualifiers to the frost until it in not ambiguous.

The next two look to be the same actually issue which is you have put two back ticks before "None" and only one after so the rst parsing is failing.

Additionally, I think the "Paremeters" section should goafter the the paragraph you put it above.

@tacaswell
Copy link
Member

Closing in favor of#23618

I have never seen github driven to this state where two PRs both report they are against the same branch.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

3 participants
@haziq-khurshid@tacaswell@QuLogic

[8]ページ先頭

©2009-2025 Movatter.jp