docs(ast): docs for AstBuilder *_with_* methods list extra field names, not field types#9206
Merged
graphite-app[bot] merged 1 commit intomainfrom Feb 18, 2025
Conversation
github-actions
bot
added
A-ast
This was referenced Feb 18, 2025
Member
Author
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. This stack of pull requests is managed by Graphite. Learn more about stacking. |
CodSpeed Performance ReportMerging #9206 will not alter performanceComparing Summary
|
Member
Merge activity
|
…names, not field types (#9206) In docs for `AstBuilder` methods, list the extra field names, not the *type* of the fields. When we add default fields which are `bool` e.g. `no_side_effects: bool`, this will produce comments that make more sense. Before: ```rs /// Build a [`Program`] with `ScopeId`. /// Build a [`Function`] with `bool`. ``` After: ```rs /// Build a [`Program`] with `scope_id`. /// Build a [`Function`] with `no_side_effects`. ```
graphite-app
bot
force-pushed
the
02-18-feat_ast_tools_add_builder_skip_attribute_for_structs_and_enums
branch
from
5c44e0c to
124b3cb
Compare
graphite-app
bot
force-pushed
the
02-18-docs_ast_docs_for_astbuilder__with__methods_list_extra_field_names_not_field_types
branch
from
8a76d33 to
70726e9
Compare
Base automatically changed from
02-18-feat_ast_tools_add_builder_skip_attribute_for_structs_and_enums
to
main
February 18, 2025 15:01
graphite-app
bot
deleted the
02-18-docs_ast_docs_for_astbuilder__with__methods_list_extra_field_names_not_field_types
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In docs for
AstBuildermethods, list the extra field names, not the type of the fields. When we add default fields which areboole.g.no_side_effects: bool, this will produce comments that make more sense.Before:
After: