(PDOC-295) Add @enum tag support for Enum data types #215
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
seanmil
force-pushed
the
add_enum_tag
branch
2 times, most recently
from
dab6101 to
8e5ffe1
Compare
seanmil
changed the title
|
I think the acceptance test failure is due to a PDK "missing require" bug that should be fixed with the new PDK release this week. After that I'm 👍 to merge this. |
|
Re-kicking CI now that PDK 1.14.1 gem has been released. |
|
Fresh new failures now, hoping #217 will resolve |
Enum data types would benefit from the ability to add extended documentation on each option similarly to the '@option' tag for hashes. The option type is not a good fit for Enum data type parameters as it requires data types to be specified, which doesn't make sense in the context of a Enum type.
|
Rebased on top of #217. |
|
Hooray, CI passing now! |
scotje
approved these changes
Nov 1, 2019
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Enumdata types would benefit from the ability to add extendeddocumentation on each option similarly to the
@optiontagfor hashes. The
@optiontype is not a good fit forEnumdatatype parameters as it requires data types to be specified,
which doesn't make sense in the context of an
Enumtype.This patch adds a new
@enumtag which behaves like @option,but does not accept the data type parameter that
@optiondoes.