Document how return types and return values should be used in docstrign signature lines #57583
Conversation
…gn signature lines
|
Perhaps also add to the style guide in the manual? |
Yep! That's #57580 |
Co-authored-by: Neven Sajko <[email protected]>
Co-authored-by: Neven Sajko <[email protected]>
|
thumbs down because #57012 (comment) (sorry i didn't see this discussion til this PR, so understand this might have been decided, but i do think it could have an unintended consequence if it spreads an anti-pattern in code itself) |
This comment was marked as resolved.
This comment was marked as resolved.
|
@nickrobinson251, thank you for sharing your concern that using Some additional factors I'm considering here are
|
LilithHafner
added
merge me
LilithHafner
removed
the
merge me
In cases where a function is documented as
```
function(arg::ArgT, arg2::Arg2T) -> RetT
...
```
I either switched ` -> ` to `::` or switched `RetT` to `ret_name::RetT`.
From the recommendation and justification from @nsajko here:
#56978 (comment) and
applied throughout the repo.
As documented here #57583
Also includes some minor changes to touched lines (e.g. removing annotations that are just clutter)
In cases where a function is documented as
```
function(arg::ArgT, arg2::Arg2T) -> RetT
...
```
I either switched ` -> ` to `::` or switched `RetT` to `ret_name::RetT`.
From the recommendation and justification from @nsajko here:
JuliaLang#56978 (comment) and
applied throughout the repo.
As documented here JuliaLang#57583
Also includes some minor changes to touched lines (e.g. removing annotations that are just clutter)
Implements the first step in #57012 (comment). See the discussion there for more info. Once this merges, #57012 will implement the recommended method throughout base and in-tree stdlibs.