-
-
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
Better documentation and docs search for punctuation #33344
Conversation
Co-Authored-By: James Bradbury <[email protected]>
Co-Authored-By: James Bradbury <[email protected]>
What's required to make progress here? This is a great improvement. |
I just need to figure out how to make all those cross-links. I poked at it for a little bit but made no progress. I'll try again this afternoon. |
Hm, I tried all possible combinations of |
working around JuliaDocs/Documenter.jl#781
Who might know how to do this? @mortenpi maybe? |
I think the relevant issue is JuliaDocs/Documenter.jl#781 — that is, it's not possible at the moment. |
Test failures are now unrelated. Anything else here? |
This tries to make documentation for Julia's punctuation and obscure syntaxes a bit more discoverable. Adds keyword doc strings for things like
{
and[
, updates the punctuation chapter of the documentation to include the names of the punctuation characters so its more searchable, and adds a whole slew of cross-links between everything.I also got sniped into re-writing a bit of the array literal section of the array manual.
Here's one example. Before:
After: