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

doc: fix accumulate examples not using the init keyword #28910

Merged
merged 2 commits into from
Sep 3, 2018

Conversation

rfourquet
Copy link
Member

@rfourquet rfourquet commented Aug 27, 2018

I replaced accumulate! with tryparse in one example because it's the first fitting function I found whose docstring was actually short (compared to that of accumulate!).

@rfourquet rfourquet added docs This change adds or pertains to documentation bugfix This change fixes an existing bug labels Aug 27, 2018
"""
```

This will create a link in the generated docs to the `accumulate` documentation
This will create a link in the generated docs to the `parse` documentation
Copy link
Member

Choose a reason for hiding this comment

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

"and nothing"? Also should the parse have a @ref in this sentence (it kinda shows what is described with an example then)

Copy link
Member Author

Choose a reason for hiding this comment

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

I hesitated for nothing as it doesn't fall in the one the two categories below (mutating/non-mutating and similar-seeming functions), but no problem to do it. Good idea to add a ref link here too.

@rfourquet
Copy link
Member Author

I will merge by tomorrow if no objection.

@KristofferC KristofferC mentioned this pull request Sep 3, 2018
@KristofferC KristofferC merged commit 49e58ba into master Sep 3, 2018
KristofferC pushed a commit that referenced this pull request Sep 3, 2018
* doc: fix accumulate examples not using the init keyword

* add links (KristofferC)

(cherry picked from commit 49e58ba)
@fredrikekre fredrikekre deleted the rf/fix-acc-doc branch September 3, 2018 19:32
KristofferC pushed a commit that referenced this pull request Sep 8, 2018
* doc: fix accumulate examples not using the init keyword

* add links (KristofferC)

(cherry picked from commit 49e58ba)
KristofferC pushed a commit that referenced this pull request Sep 8, 2018
* doc: fix accumulate examples not using the init keyword

* add links (KristofferC)

(cherry picked from commit 49e58ba)
KristofferC pushed a commit that referenced this pull request Feb 11, 2019
* doc: fix accumulate examples not using the init keyword

* add links (KristofferC)

(cherry picked from commit 49e58ba)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix This change fixes an existing bug docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants