Marking internal action as @ignore to remove them from the documentation. #42163
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
|
Size Change: -10 B (0%) Total Size: 1.26 MB
ℹ️ View Unchanged
|
|
Should we follow with WordPress core and use |
gziolo
reviewed
Jul 6, 2022
| @@ -90,58 +90,6 @@ _Returns_ | |||
|
|
|||
| - `Object`: Action object. | |||
|
|
|||
| ### receiveAutosaves | |||
There was a problem hiding this comment.
It looks like we print the same content in @wordpress/core-data's README file. Should we link to the reference gude instead?
gziolo
added
[Type] Developer Documentation
ryanwelcher
changed the title
|
Now that #42198 has been merged, we can use |
ryanwelcher
requested review from
nerrad,
ajitbohra,
juanmaguitar and
fabiankaegy
as code owners
|
@youknowriad @adamziel @Mamaduka @mtias I'd love any input you may have on this. |
|
The change makes sense to me. The internal actions aren't beneficial if you're not working on the core. |
|
I like the direction. We should stop promoting code that can be expressed in a more general way today. It would be great to leave a not in JSDoc explaining why it's ignored, so it's clear that usage of those functions is discouraged. |
That's a great idea. Maybe we can do something like - |
Looks like the linter won't allow this, I get the following when trying to commit.
Seems we'd need to make a change to https://github.com/WordPress/gutenberg/blob/trunk/packages/eslint-plugin/configs/jsdoc.js#L128 to allow that. Personally, I really this the idea of having the reason in line with the tag so I'll add that change to this PR. |
|
Based on a conversation in Slack with @gziolo , it looks like core always has the |
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.
What?
This PR marks internal actions that are not meant to be accessed outside of this store as
@ignoreto remove them from the related docs.Why?
Having these items in the docs just adds noise to the documentation and has no real value. There is a larger conversation around how these are marked but backed on the JSDoc tags in the documentation standards this should be the correct tag to use.