-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
Conversation
doc/src/manual/documentation.md
Outdated
""" | ||
``` | ||
|
||
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 |
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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.
I will merge by tomorrow if no objection. |
* doc: fix accumulate examples not using the init keyword * add links (KristofferC) (cherry picked from commit 49e58ba)
* doc: fix accumulate examples not using the init keyword * add links (KristofferC) (cherry picked from commit 49e58ba)
* doc: fix accumulate examples not using the init keyword * add links (KristofferC) (cherry picked from commit 49e58ba)
* doc: fix accumulate examples not using the init keyword * add links (KristofferC) (cherry picked from commit 49e58ba)
I replaced
accumulate!
withtryparse
in one example because it's the first fitting function I found whose docstring was actually short (compared to that ofaccumulate!
).