Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

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

wants to merge 1 commit into from

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 (and pytest passes).
  • [ N/A] Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

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

@tacaswell
Copy link
Member

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

@haziq-khurshid
Copy link
Contributor Author

@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 go after 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 free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants