Add newoption.catagory to documentation, mark os.is as deprecated#1954
Add newoption.catagory to documentation, mark os.is as deprecated#1954KyrietS merged 2 commits intopremake:masterfrom
Conversation
website/docs/newoption.md
Outdated
| | value | Optional. If the option needs a value, provides a hint to the user what type of data is expected. | | ||
| | allowed | Optional. A list of key-value pairs listing the allowed values for the option. | | ||
| | default | Optional. Sets the default for this option if not specified on the commandline. | | ||
| | category | Optional. Places the option under a seperate header when the user passes `--help` | |
There was a problem hiding this comment.
| | category | Optional. Places the option under a seperate header when the user passes `--help` | | |
| | category | Optional. Places the option under a separate header when the user passes `--help` | |
There was a problem hiding this comment.
Thanks! Fixed with a force push to minimise commits. Sorry if that means you miss out on credit...
|
Will leave this open for comment for a few days, then merge if no changes need to be made. |
website/docs/os.is.md
Outdated
| os.is("id") | ||
| ``` | ||
|
|
||
| **This function has been deprecated.** Use [os.target()](os.target.md) or [os.host()](os.host.md) instead. |
There was a problem hiding this comment.
Maybe we could use fancy-dancy Admonitions for the first time on our website? 😀
It would be:
:::caution
**This function has been deprecated.** Use [os.target()](os.target.md) or [os.host()](os.host.md) instead.
:::
I've tested it on my local demo branch for configuration: https://kyriets.github.io/premake-core/docs/configuration/
What do you think?
There was a problem hiding this comment.
Ah yes, I was actually looking for something like this.
Happy to make this change and also make a separate PR that uses them for all deprecation notices?
There was a problem hiding this comment.
On second thoughts, maybe it's clearer to leave this PR as is and make a new one that does the change everywhere
There was a problem hiding this comment.
I think we use it here now, in case no one gets around to the follow up PR to do it everywhere immediately.
|
Bump, any other change requests? |
|
Thanks for your contribution 🤗 |
4 participants
What does this PR do?
Closes #1859
Adds a description of the
categoryoption when usingnewoption.Also marks
os.is()as deprecated which is mentioned in the same issue.How does this PR change Premake's behavior?
No. Should only be docs changes.
Anything else we should know?
Nope.
Did you check all the boxes?
closes #XXXXin comment to auto-close issue when PR is merged)