docs: add reference to default options list #680
+74
−0
Conversation
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
hesreallyhim
requested review from
aymanbagabas and
kujtimiihoxha
and removed request for
a team
Contributor
|
I think that ideally, the setting, description and default should be in the same table where possible. |
Author
I just did it this way for minimal disturbance to the main README. |
Contributor
The problem I had with this to start is that you have to look in two places for the information. This simplifies the two places, but it remains at two. The 'what is the default' question is now answered by:
|
Author
|
@joshka maybe I could put the defaults table inside a disclosure element. I'm open to whatever, and totally respect your opinion but also want to hear from a codeowner 😉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
CONTRIBUTING.md.I have created a discussion that was approved by a maintainer (for new features).(docs-only)I found myself looking through the code to find the default values for various Options settings, so I thought it would be helpful to provide the user with a list of these settings in the README. So as to make the smallest visible change to the existing docs, I added a link in the README to a new Markdown table I assembled (with LLM assistance) based off of the info in
vhs.goand related files likestyles.go.If you want to "check my work" there is a file in 037d437 which contains a CSV file I built up to compile the information including line references for the different settings.
Thanks, this library is amazing!
(Partially?) Fixes: #638
(Partially?) Fixes: #495 (duplicate)