(PDOC-3) Rename face to strings instead of yardoc#4
Merged
zaphod42 merged 3 commits intopuppetlabs:masterfrom Sep 17, 2014
Merged
(PDOC-3) Rename face to strings instead of yardoc#4zaphod42 merged 3 commits intopuppetlabs:masterfrom
zaphod42 merged 3 commits intopuppetlabs:masterfrom
Conversation
Since we don't want the name of the tool to reflect the fact that it is using yard internally (this is an implementation detail), rename the face to `strings`. Now when one wishes to generate documentation, `puppet strings` will be used rather than `puppet yardoc`.
Contributor
Author
|
Please don't merge this yet. I need to add one more big refactor around the directory structure. |
In order to keep with conventions around directory structure, add a puppetlabs directory and rename modules accordingly.
Prior to this commit, the handlers and code objects which dealt with puppet functions were referred to as `FutureParserFunctions` and `ParseFunctions`. This naming convention will not make very much sense going forward when the future parser becomes the primary parser. Therefor, rename `FutureParserFunctions` to `Puppet4xFunctions` and `ParserFunctions` to `Puppet3xFunctions`.
Contributor
Author
|
Alright, all things have been renamed! This pull request should now be ready for review. |
Contributor
There was a problem hiding this comment.
D'oh. Typo. Pupet => Puppet
Contributor
|
I'll merge this even with the typo. The correct thing is to reference the constant rather than use the string, that way ruby can check that the spelling matches up. |
zaphod42
added a commit
that referenced
this pull request
Sep 17, 2014
(PDOC-3) Rename face to strings instead of yardoc
Contributor
Author
|
Whoops, sorry! I'll switch to using the constant and include that in my next pull request |
4 tasks
eputnam
added a commit
to eputnam/puppet-strings
that referenced
this pull request
Mar 19, 2018
# This is the 1st commit message: (PDOC-206) starting work for tasks # This is the commit message puppetlabs#2: (PDOC-206) parser, handler, statement, code_object Adds a parser for json, a task handler, a task statement and a task code_object. the parser uses JSON.parse instead of an AST and some finagling has to be done in the statement and the handler to get YARD to be ok with this. When YARD is registering the task code_object, it expects it to have things like a docstring and comments and so on, but it doesn't have any of those things so they are faked. # This is the commit message puppetlabs#3: (PDOC-206) refactor handler/parser/co interaction and json_spec passes to_hash does not need to behave like it does in other code objects. instead, just take the raw json and iterate over it. # This is the commit message puppetlabs#4: (PDOC-206) things work now # This is the commit message puppetlabs#5: (PDOC-206) small refactor/improvement of input section # This is the commit message puppetlabs#6: moved some things around, added some template logic # This is the commit message puppetlabs#7: (PDOC-206) adds more tests # This is the commit message puppetlabs#8: (PDOC-206) remodel to_hash and start markdown Revamped the to_hash method for task code objects to look more like other objects. The markdown engine cares a lot about this format. # This is the commit message puppetlabs#9: (PDOC-206) update json test, task template
smortex
pushed a commit
to smortex/puppet-strings
that referenced
this pull request
Aug 10, 2025
Rake task allows for a different commit message
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Since we don't want the name of the tool to reflect the fact that
it is using yard internally (this is an implementation detail), rename
the face to
strings. Now when one wishes to generate documentation,puppet stringswill be used rather thanpuppet yardoc.