Extract and improve documentation #110
Merged
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
MVP. Still needs to parse formatting.
We assume an 80-column terminal as a conservative default. Having at least 2 blank columns at the end of a line helps readability (for understanding that a line has ended and hasn't been cut off). However, paragraphs are indented 2 spaces in the built-in help, leaving a limit of 76 columns.
glguy
approved these changes
Jan 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The goal of this branch is to extract the command documentation from glirc's source code into separate files, then make use of Template Haskell to add it back in. This allows viewing up-to-date documentation for glirc without running it, and makes editing said docs easier.
This branch contains a minimum viable implementation. It supports an extremely limited subset of AsciiDoc, but documents every command in glirc. Further work can be done on supporting more of AsciiDoc as-needed, as well as refining the documentation itself.