Added support for hidden option for documentation #38
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
vitoravelino
force-pushed
the
hidden-doc-option
branch
3 times, most recently
from
8ec38e8
to
b0beb5c
Compare
Currently there's no way of avoding the exposure of an entity attribute. Sometimes there are internal and conditional attributes that are not important to be known in the documentation to whoever is consuming that entity. In this case, we are simply checking if there's a `hidden` attribute in the `documentation` options and we skip it when parsing the entity attributes. Signed-off-by: Vítor Avelino <vavelino@suse.com>
vitoravelino
force-pushed
the
hidden-doc-option
branch
from
b0beb5c
to
d09fea8
Compare
2 tasks
|
thanks @vitoravelino … looks good to me |
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.
Currently there's no way of avoding the exposure of an entity attribute.
Sometimes there are internal and conditional attributes that are not
important to be known in the documentation to whoever is consuming that
entity.
In this case, we are simply checking if there's a
hiddenattribute inthe
documentationoptions and we skip it when parsing the entityattributes.
Signed-off-by: Vítor Avelino vavelino@suse.com