search

puppetlabs / puppetlabs-augeas_core

Manage files using Augeas
Apache License 2.0
3 stars 24 forks source link

(MODULES-8183) Fix ToC truncation in REFERENCE.md #42

Closed GabrielNagy closed 3 years ago

GabrielNagy commented 3 years ago

Puppet Strings prefers a @summary tag with a max of 140 characters to fill in the Table of Contents summary. Without this, the description will appear truncated.

Add @summary and @example tags to the type documentation.

puppet-community-rangefinder[bot] commented 3 years ago

augeas is a type

that may have no external impact to Forge modules.

This module is declared in 5 of 578 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.

GabrielNagy commented 3 years ago

Used the following to re-generate the file:

bundle exec puppet strings generate --format markdown --out REFERENCE.md

The good: puppet code blocks are now syntax-highlighted The bad (?): the summary string for the type will only be shown in the table of contents