[components] Update docs commenting logic #27162
Open
Conversation
This file contains 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
This was referenced Jan 16, 2025
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
OwenKephart
commented
Jan 16, 2025
| @@ -26,8 +26,8 @@ def test_generate_sample_yaml(): | |||
|
|
|||
| params: | |||
| sub_scoped: # Available scope: {'outer_scope'} | |||
| str_field: '...' | |||
| int_field: 0 | |||
| str_field: '...' # Available scope: {'outer_scope'} | |||
There was a problem hiding this comment.
it was actually a bug that these comments weren't showing up before
in terms of desired behavior, the previous output might actually have been nicer but now it's much easier to choose which way we want this to appear
OwenKephart
force-pushed
the
01-15-_components_update_resolution_deferral_logic
branch
from
6bd100f to
46d40ae
Compare
OwenKephart
force-pushed
the
01-15-_components_update_docs_commenting_logic
branch
from
aeb1eec to
00bac33
Compare
OwenKephart
force-pushed
the
01-15-_components_update_resolution_deferral_logic
branch
from
46d40ae to
4d52208
Compare
OwenKephart
force-pushed
the
01-15-_components_update_docs_commenting_logic
branch
from
00bac33 to
d4b4c59
Compare
OwenKephart
force-pushed
the
01-15-_components_update_resolution_deferral_logic
branch
from
4d52208 to
d3411b7
Compare
OwenKephart
force-pushed
the
01-15-_components_update_docs_commenting_logic
branch
from
d4b4c59 to
f81a367
Compare
OwenKephart
force-pushed
the
01-15-_components_update_resolution_deferral_logic
branch
2 times, most recently
from
1803966 to
3d10ad3
Compare
OwenKephart
force-pushed
the
01-15-_components_update_docs_commenting_logic
branch
from
f81a367 to
731e9fd
Compare
OwenKephart
force-pushed
the
01-15-_components_update_resolution_deferral_logic
branch
from
3d10ad3 to
58bdbcc
Compare
OwenKephart
force-pushed
the
01-15-_components_update_docs_commenting_logic
branch
from
731e9fd to
3b2c68d
Compare
This was referenced Jan 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary & Motivation
This simplifies the docs commenting logic by re-using the source-position loader. In essence, we dump the yaml, then parse it again so we can map the values to source positions, then emit comments on lines where we need to.
This is a lot easier to build off of and less sketchy than the previous implementation.
How I Tested These Changes
Changelog
NOCHANGELOG