There should only be one list of command-line options #618
Milestone
Comments
|
|
|
The wiki lists the command-line options available when the project started. Since then, several have been removed and added. The source of truth should be It could be its own issue, but the game itself should know what options it supports and be able to display a help menu when launched with |
Jayman2000
added a commit
to Jayman2000/Descent3-pr
that referenced
this issue
Oct 6, 2024
This commit takes all of the command-line options documentation from the wiki [1] and merges it with the command-line options documentation that’s in USAGE.md. This change will eventually allow us to remove the command-line options documentation from the wiki so that we only have one list of command-line options instead of two. Before this change, USAGE.md used a Markdown table and the wiki used an HTML table. I ended up replacing the Markdown table in USAGE.md with an HTML table because it was easier to copy and paste the HTML table from the wiki than to convert the HTML table from the wiki into a Markdown table. The main motivation behind this change is to make it easier to create a future commit. That future commit will add documentation for the -additionaldir command-line option. Making sure that there’s only one list of command-line options instead of two will make it so that -additionaldir doesn’t need to be documented in two different places. This is related DescentDevelopers#618, but it doesn’t fully fix the issue. [1]: <https://github.com/DescentDevelopers/Descent3/wiki/Running-Descent-3#command-line-options>
Jayman2000
added a commit
to Jayman2000/Descent3-pr
that referenced
this issue
Oct 6, 2024
This commit takes all of the command-line options documentation from the wiki [1] and merges it with the command-line options documentation that’s in USAGE.md. This change will eventually allow us to remove the command-line options documentation from the wiki so that we only have one list of command-line options instead of two. Before this change, USAGE.md used a Markdown table and the wiki used an HTML table. I ended up replacing the Markdown table in USAGE.md with an HTML table because it was easier to copy and paste the HTML table from the wiki than to convert the HTML table from the wiki into a Markdown table. The main motivation behind this change is to make it easier to create a future commit. That future commit will add documentation for the -additionaldir command-line option. Making sure that there’s only one list of command-line options instead of two will make it so that -additionaldir doesn’t need to be documented in two different places. This is related DescentDevelopers#618, but it doesn’t fully fix that issue. [1]: <https://github.com/DescentDevelopers/Descent3/wiki/Running-Descent-3#command-line-options>
13 tasks
Jayman2000
added a commit
to Jayman2000/Descent3-pr
that referenced
this issue
Oct 20, 2024
This commit takes all of the command-line options documentation from the wiki [1] and merges it with the command-line options documentation that’s in USAGE.md. This change will eventually allow us to remove the command-line options documentation from the wiki so that we only have one list of command-line options instead of two. Before this change, USAGE.md used a Markdown table and the wiki used an HTML table. I ended up replacing the Markdown table in USAGE.md with an HTML table because it was easier to copy and paste the HTML table from the wiki than to convert the HTML table from the wiki into a Markdown table. The main motivation behind this change is to make it easier to create a future commit. That future commit will add documentation for the -additionaldir command-line option. Making sure that there’s only one list of command-line options instead of two will make it so that -additionaldir doesn’t need to be documented in two different places. This is related DescentDevelopers#618, but it doesn’t fully fix that issue. [1]: <https://github.com/DescentDevelopers/Descent3/wiki/Running-Descent-3#command-line-options>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
At the moment, both
USAGE.mdand the wiki have lists of command-line options for Descent 3. It would be better if there was just one list instead of two.In the PR description for #471, I said that I would open a pull request that adds documentation for
-additionaldirif #471 got merged. Now that #471 has been merged, it’s not clear to me if I should add the documentation toUSAGE.md, the wiki or both. If there was only one list of command-line options, then it would be clear where documentation for new command-line options should go.The text was updated successfully, but these errors were encountered: