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

include the doc strings of .=, ., ->, :: into the docs #55046

Merged

Conversation

nsajko
Copy link
Contributor

@nsajko nsajko commented Jul 5, 2024

No description provided.

@nsajko nsajko added docs This change adds or pertains to documentation DO NOT MERGE Do not merge this PR! labels Jul 5, 2024
@nsajko

This comment was marked as resolved.

@nsajko nsajko removed the DO NOT MERGE Do not merge this PR! label Jul 5, 2024
@nsajko
Copy link
Contributor Author

nsajko commented Jul 5, 2024

Looking at the documentation PDF produced by CI, all four entries are successfully included into the Keywords subsection. Follow up PRs will add some cross-references.

@Seelengrab
Copy link
Contributor

If this fixes #36290, it'd be good to link the two here :)

@nsajko
Copy link
Contributor Author

nsajko commented Jul 8, 2024

This PR includes the doc string for :: into the docs, but I don't know if that will make the search functionality be able to find ::. I guess we'll find out when this is merged.

@Seelengrab
Copy link
Contributor

Seelengrab commented Jul 8, 2024

Good point - I'm subscribed to this PR, so I'll check once it's merged. If it's fixed, I'll close #36290 manually.

@nsajko
Copy link
Contributor Author

nsajko commented Jul 14, 2024

ping

1 similar comment
@nsajko
Copy link
Contributor Author

nsajko commented Jul 20, 2024

ping

@fatteneder fatteneder merged commit c0f7df1 into JuliaLang:master Jul 24, 2024
8 of 10 checks passed
@nsajko nsajko deleted the type_declaration_doc_string_into_docs branch July 24, 2024 21:04
lazarusA pushed a commit to lazarusA/julia that referenced this pull request Aug 17, 2024
@Seelengrab
Copy link
Contributor

It took a while until I remembered this, but it seems like this PR didn't fix :: being unfindable in the docs.

@nsajko
Copy link
Contributor Author

nsajko commented Oct 12, 2024

Well the doc string is here: https://docs.julialang.org/en/v1.12-dev/base/base/#::

@Seelengrab
Copy link
Contributor

Yes, it's probably some issue with the filtering happening in JS... Not sure how much we can do about it, though I think there is an issue in Documenter.jl about this too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants