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

Documentation style updates #227

Merged

Conversation

ody
Copy link
Contributor

@ody ody commented Apr 16, 2019

Commits updates or adds "puppet strings" documentation that adheres to style guide and semantics understood by YARD. Does not prioritize the correctness or verifying the validity of documentation...

Close examination of documentation validity to be handled after manifests are consistently documented.

@ody ody force-pushed the general_documentation_improvements branch 2 times, most recently from e41a5c5 to 862c0b3 Compare April 18, 2019 18:48
@ody ody changed the title [WIP] Documentation style updates Documentation style updates Apr 18, 2019
Rakefile Outdated
@@ -4,6 +4,7 @@ require 'puppetlabs_spec_helper/rake_tasks'
# only available if gem group releases is installed
begin
require 'voxpupuli/release/rake_tasks'
require 'puppet-strings/tasks'
Copy link
Member

Choose a reason for hiding this comment

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

I am not sure if this is necessary, because this module already has an task to create the REFERENCE.md:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dhoppe You were correct, removed it

	Commits updates or adds "puppet strings" documentation that
	adheres to style guide and semantics understood by YARD. Does
	not correct or verify the validity of documentation...

	Validity of existing documentation to be address in separate PR
@ody ody force-pushed the general_documentation_improvements branch from 862c0b3 to 3c02de0 Compare April 30, 2019 17:21
@bastelfreak bastelfreak merged commit 2509af8 into voxpupuli:master May 17, 2019
@bastelfreak bastelfreak added the docs Improvements or additions to documentation label May 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants