Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix option tag handling with no data types #361

Merged

Conversation

seanmil
Copy link
Contributor

@seanmil seanmil commented Aug 4, 2023

Do not error if no data types are provided to the option tag. Instead, generate a suitable line excluding the data type.

Summary

When using the @option tag if a data type is not specified then rendering to Markdown will result in an exception being raised. This fixes that so an appropriate documentation line is emitted instead.

Checklist

  • 🟢 Spec tests.
  • 🟢 Acceptance tests.
  • Manually verified.

Do not error if no data types are provided to the option tag.
Instead, generate a suitable line excluding the data type.
@seanmil seanmil requested a review from a team as a code owner August 4, 2023 15:25
@jordanbreen28
Copy link
Contributor

Thanks for this @seanmil!

@jordanbreen28 jordanbreen28 merged commit b826f57 into puppetlabs:main Aug 4, 2023
12 checks passed
@seanmil seanmil deleted the fix_options_without_types_markdown branch October 16, 2023 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants