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.

Sign up for GitHub

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

Jump to bottom

JuliaSyntax's documentation is overflowing into the main Julia documentation #54749

Open
Paalon opened this issue Jun 10, 2024 · 0 comments
Open

JuliaSyntax's documentation is overflowing into the main Julia documentation #54749

Paalon opened this issue Jun 10, 2024 · 0 comments
Labels
docs This change adds or pertains to documentation

Comments

@Paalon
Copy link
Contributor

Paalon commented Jun 10, 2024 •
edited
Loading

JuliaSyntax's documentation is overflowing into the main Julia documentation. The documentation of position(l::Lexer) and eof(l::Lexer) are overflowing.

スクリーンショット 2024-06-10 16 24 23

スクリーンショット 2024-06-10 17 03 16

スクリーンショット 2024-06-10 17 03 43

I think these should be hidden.
@Seelengrab Seelengrab added the docs This change adds or pertains to documentation label Jun 10, 2024
nhz2 added a commit to nhz2/JuliaSyntax.jl that referenced this issue Jun 16, 2024
@nhz2
Update Base.peek docstring
3dca95e 
When looking at the help for `peek` in the repl, the current docstring looks like it applies to all `IO`, so I added `::ParseStream` to make it more specific. See also JuliaLang/julia#54749
@nhz2 nhz2 mentioned this issue Jun 16, 2024
Merged
@jakobnissen jakobnissen mentioned this issue Jun 17, 2024
Open
Octogonapus added a commit to Octogonapus/julia that referenced this issue Jul 15, 2024
@Octogonapus
JuliaLang#54749, JuliaLang#54831: Prevent JuliaSyntax docs from leaki…
262aa27 
…ng into Base
@Octogonapus Octogonapus mentioned this issue Jul 15, 2024
Merged
Octogonapus added a commit to Octogonapus/julia that referenced this issue Jul 15, 2024
@Octogonapus
JuliaLang#54749, JuliaLang#54831: Prevent JuliaSyntax docs from leaki…
a24234b 
…ng into Base
c42f pushed a commit to JuliaLang/JuliaSyntax.jl that referenced this issue Jul 21, 2024
@nhz2 @c42f
Update Base.peek docstring
2ecad86 
When looking at the help for `peek` in the repl, the current docstring looks like it applies to all `IO`, so I added `::ParseStream` to make it more specific. See also JuliaLang/julia#54749
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs This change adds or pertains to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Paalon @Seelengrab