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

Help mode documentation for ternary operator #35637

Merged
merged 1 commit into from
Apr 30, 2020
Merged

Help mode documentation for ternary operator #35637

merged 1 commit into from
Apr 30, 2020

Conversation

c42f
Copy link
Member

@c42f c42f commented Apr 29, 2020

Fixes #35636

Here I've stolen the single ? as an alias for displaying the introduction text, as the intro text already has multiple other ways to show it (including simply pressing Return while in help mode).

I've also tried out something unusual which is linking to the manual documentation which describes this syntax in more detail. (Obviously we should have a better way to create such links without direct URLs, but for now I think this is the only way to do it?)

base/docs/basedocs.jl Outdated Show resolved Hide resolved
base/docs/basedocs.jl Outdated Show resolved Hide resolved
base/docs/basedocs.jl Outdated Show resolved Hide resolved
base/docs/basedocs.jl Show resolved Hide resolved
@c42f
Copy link
Member Author

c42f commented Apr 30, 2020

Thanks @fredrikekre for the review, I think I've figured out how to incorporate those suggestions without breaking things. Any further thoughts?

base/docs/basedocs.jl Outdated Show resolved Hide resolved
@fredrikekre fredrikekre added the domain:docs This change adds or pertains to documentation label Apr 30, 2020
@fredrikekre
Copy link
Member

Would be good to include it in the manual too, maybe in the same section as if in https://github.com/JuliaLang/julia/blob/master/doc/src/base/base.md

@c42f
Copy link
Member Author

c42f commented Apr 30, 2020

Would be good to include it in the manual too

Done + rebased+squashed.

@ViralBShah
Copy link
Member

@c42f Please merge if ready to go.

@c42f c42f merged commit ae2063f into master Apr 30, 2020
@c42f c42f deleted the cjf/ternary-docs branch April 30, 2020 21:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docstring for the ternary operator
3 participants