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

Fix documentation typo: gratesettings => grate_settings #511

Merged
merged 1 commit into from
May 7, 2024

Conversation

salticus
Copy link
Contributor

@salticus salticus commented May 6, 2024

Minor fix to documentation typo.

In docs/ConfigurationOptions/ResponseFiles.md the example response file is named first grate_settings.rsp then gratesettings.rsp. Testing on Ubuntu showed that this would result in the following error:

Response file not found './gratesettings.rsp'.

(Not being familiar with ResponseFiles, this seemed worth testing, in case there was some kind of "remove all underscores in a filename" magic going on.)

@erikbra
Copy link
Owner

erikbra commented May 7, 2024

Thanks a lot for you contribution! Documentation fixes are some of the most important ones. If the docs are incorrect, nothing works!

That said, please don't build too much infrastructure on top of the .rsp feature. I'm considering migrating to another command-line parsing library, as System.CommandLine never seems to go out of beta (and I think it never will, in the current form). So the .rsp support might disappear in the future 😄

@erikbra erikbra merged commit 14e4ea4 into erikbra:main May 7, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants