Skip to content

(SUP-3409) Update puppet strings comments #104

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

Merged
merged 3 commits into from
Jul 21, 2022

Conversation

elainemccloskey
Copy link
Contributor

Update format of comments to be picked up by puppet strings

@elainemccloskey elainemccloskey requested a review from a team as a code owner July 20, 2022 15:10
@puppet-community-rangefinder
Copy link

pe_databases is a class

that may have no external impact to Forge modules.

pe_databases::pg_repack is a class

that may have no external impact to Forge modules.

pe_databases::postgresql_settings is a class

that may have no external impact to Forge modules.

pe_databases::postgresql_settings::table_settings is a class

that may have no external impact to Forge modules.

pe_databases::set_puppetdb_table_autovacuum_cost_delay_zero is a type

that may have no external impact to Forge modules.

pe_databases::set_table_attribute is a type

that may have no external impact to Forge modules.

This module is declared in 0 of 579 indexed public Puppetfiles.


These results were generated with Rangefinder, a tool that helps predict the downstream impact of breaking changes to elements used in Puppet modules. You can run this on the command line to get a full report.

Exact matches are those that we can positively identify via namespace and the declaring modules' metadata. Non-namespaced items, such as Puppet 3.x functions, will always be reported as near matches only.

Copy link
Contributor

@MartyEwings MartyEwings left a comment

Choose a reason for hiding this comment

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

Looks good to me.

i see pdk is still complaining of the following:

pdk (WARNING): puppet-lint: defined type not documented (manifests/set_table_attribute.pp:6:1)
pdk (WARNING): puppet-lint: class not documented (manifests/postgresql_settings/table_settings.pp:6:1)
pdk (WARNING): puppet-lint: defined type not documented (manifests/set_puppetdb_table_autovacuum_cost_delay_zero.pp:6:1)
pdk (WARNING): puppet-lint: class not documented (manifests/init.pp:6:1)
pdk (WARNING): puppet-lint: class not documented (manifests/pg_repack.pp:6:1)
pdk (WARNING): puppet-lint: class not documented (manifests/postgresql_settings.pp:6:1)

Is that being address in a separate pull if so ill merge this

Copy link
Contributor

@MartyEwings MartyEwings left a comment

Choose a reason for hiding this comment

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

more details

[warn]: Missing documentation for Puppet class 'pe_databases' at manifests/init.pp:6.
[warn]: Missing @param tag for parameter 'database_type' near manifests/collect.pp:2.
[warn]: Missing @param tag for parameter 'command' near manifests/collect.pp:2.
[warn]: Missing @param tag for parameter 'disable_maintenance' near manifests/collect.pp:2.
[warn]: Missing @param tag for parameter 'on_cal' near manifests/collect.pp:2.
[warn]: Missing documentation for Puppet class 'pe_databases::pg_repack' at manifests/pg_repack.pp:6.
[warn]: Missing documentation for Puppet class 'pe_databases::postgresql_settings' at manifests/postgresql_settings.pp:6.
[warn]: Missing documentation for Puppet defined type 'pe_databases::set_table_attribute' at manifests/set_table_attribute.pp:6.
[warn]: Missing documentation for Puppet class 'pe_databases::postgresql_settings::table_settings' at manifests/postgresql_settings/table_settings.pp:6.
[warn]: Missing documentation for Puppet defined type 'pe_databases::set_puppetdb_table_autovacuum_cost_delay_zero' at manifests/set_puppetdb_table_autovacuum_cost_delay_zero.pp:6.
[warn]: Missing documentation for Puppet function 'pe_databases::version_based_databases' at functions/version_based_databases.pp:7.
[warn]: Missing @return tag near functions/version_based_databases.pp:7.

Copy link
Contributor

@MartyEwings MartyEwings left a comment

Choose a reason for hiding this comment

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

Looks good to me

@MartyEwings MartyEwings merged commit 72e2e21 into puppetlabs:main Jul 21, 2022
@elainemccloskey elainemccloskey deleted the SUP-3409 branch March 8, 2023 14:22
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.

2 participants