Adding documentation for the virtual printer plugin. #2142
Closed
Conversation
This file contains 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
|
Thank you for this! I took the liberty to cherry-pick this to the Since Github doesn't properly detect this I'll close this PR manually which will mark it as "closed" instead of "merged". Don't be alarmed by this, your PR was in fact merged. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What does this PR do and why is it necessary?
This PR is a pretty minor change: it adds some documentation on the virtual printer plugin. I was unable to locate much documentation and thought it would be useful for other developers such as me just getting started.
How was it tested? How can it be tested by the reviewer?
I ran
make htmlin the docs folder and this ran without errors in the files. I did get a number of errors in other files which I will try to fix in a future PR.I also inspected the resulting HTML file, which looks ok.
Any background context you want to provide?
It took me an evening to piece together the information on the virtual printer.
What are the relevant tickets if any?
None.