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

Jump to bottom

DOC: special: small improvements to the poch docstring #10947

Merged
merged 1 commit into from Oct 20, 2019
Merged

DOC: special: small improvements to the poch docstring #10947

merged 1 commit into from Oct 20, 2019

Conversation

person142
Copy link
Member

Reference issue

None.

What does this implement/fix?

This improves the docstring for special.poch.

Additional information

In particular,

  • Add a reference
  • Add examples

@person142
DOC: special: small improvements to the poch docstring
635a657 
In particular,

- Add a reference
- Add examples
@person142 person142 added scipy.special Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org labels Oct 19, 2019
tylerjereddy
tylerjereddy reviewed Oct 20, 2019
View reviewed changes
Copy link
Contributor

@tylerjereddy tylerjereddy left a comment

Choose a reason for hiding this comment

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

Looks much nicer than the devdocs version when I do a side-by-side comparison of the rendered docstrings.

Just added one minor comment

scipy/special/add_newdocs.py Show resolved Hide resolved
@rgommers rgommers merged commit 249a418 into scipy:master Oct 20, 2019
@rgommers
Copy link
Member

LGTM, merged. Thanks @person142

@rgommers rgommers added this to the 1.4.0 milestone Oct 20, 2019
@person142 person142 deleted the poch branch November 12, 2019 04:58
@person142 person142 added the special-docs-marathon Part of the NumFOCUS small grant for special function documentation (Do not delete) label Nov 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rgommers rgommers rgommers left review comments

@tylerjereddy tylerjereddy tylerjereddy left review comments

Assignees
No one assigned
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.special special-docs-marathon Part of the NumFOCUS small grant for special function documentation (Do not delete)
Projects
None yet
Milestone
1.4.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@person142 @rgommers @tylerjereddy