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.

Sign up for GitHub

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

Jump to bottom

Fix syntax for puppet-strings @example. #193

Closed
wants to merge 1 commit into from
Closed

Fix syntax for puppet-strings @example. #193

wants to merge 1 commit into from

Conversation

bschonec
Copy link
Contributor

The correct syntax is @example.

@bschonec bschonec mentioned this pull request Jun 12, 2024
Open
ekohl
ekohl requested changes Jun 12, 2024
View reviewed changes
Copy link
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Links section should also be @see. I'd avoid any URL shortener there.

Similar, I think the author should use @author for every individual author instead of using it as a block.

manifests/server/export.pp
@@ -57,7 +57,7 @@
# @param v4_export_name
# @param nfsv4_bindmount_enable
#
# @examples
# @example
#
# class { '::nfs':
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example itself needs to be indented.

manifests/server/export.pp
@@ -57,7 +57,7 @@
# @param v4_export_name
# @param nfsv4_bindmount_enable
#
# @examples
# @example
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally every example has a description, otherwise puppet-strings doesn't render it well.

@bschonec bschonec closed this Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ekohl ekohl ekohl requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@bschonec @ekohl