JuliaSyntax: Add a brief docstring for JuliaSyntax.build_tree - #63206
Conversation
35086ae to
debd2b5
Compare
build_tree
debd2b5 to
3eee1cd
Compare
3eee1cd to
89efc4b
Compare
|
@mlechu @topolarity What do you think of creating a docstring for |
|
(IIUC, the JuliaSyntax repo set this kind of thing to be a warning when building the docs, but in the Julia repo, I think we make it a hard error that fails the docs build.) |
89efc4b to
49304ef
Compare
build_treebuild_tree
build_treebuild_tree
mlechu
left a comment
There was a problem hiding this comment.
I'd prefer either removal of build_tree from the docs block, or a single docstring above function build_tree end (something like "Build a tree of type type from a raw parsed stream ps. This is the final step in parsing."
49304ef to
d309b07
Compare
|
Sounds good. Do you have a preference between those two options? |
d309b07 to
cc80f5f
Compare
|
No strong preference, just remove it if you're unsure. I think most consumers call some string->T driver function instead of doing the |
build_treeJuliaSyntax.build_tree from the @docs block
cc80f5f to
a2b4203
Compare
JuliaSyntax.build_tree from the @docs blockJuliaSyntax.build_tree from the @docs block in api.md
JuliaSyntax.build_tree from the @docs block in api.mdJuliaSyntax.build_tree
a2b4203 to
7c99a5f
Compare
`build_tree` is listed in the `@docs` block in `api.md` and is referenced with `@ref` from the `parse!` docstring, but had no docstring, so neither could resolve. Add a single docstring on a `function build_tree end` stub, as suggested in review. Assisted-by: Claude Code (Opus 5) Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
7c99a5f to
de49dc9
Compare
|
It looks like some other docstrings have |
JuliaSyntax/docs/src/api.mdcurrently has the following:julia/JuliaSyntax/docs/src/api.md
Lines 19 to 23 in c93f0c8
But
JuliaSyntax.build_treedoesn't currently have a docstring, so the docs build will fail. This PR adds a minimal docstring.🤖 Assisted-by: Claude Code:Opus 5