-
-
Notifications
You must be signed in to change notification settings - Fork 93
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
Documentation improvements #584
Documentation improvements #584
Conversation
Co-authored-by: Vodrix <Vodrix@users.noreply.github.com>
Nightly build for this pull request:
|
Good work but I suggest using the syntax that is used in Phobos and Vinifera, as it is easily copypaste-able into the INIs. You can see the examples in the Phobos or Vinifera docs for new features, I would imagine the docs looking like the following: #### [XNAControl](link)
- Some text describing what is it
- Some details
```ini
[SOMECONTROL] ; XNAControl
X=0 ; integer
Y=0 ; integer
; ...
Enabled=true ; boolean, whether the control can be interacted with
; ...
``` |
Co-authored-by: Metadorius <Metadorius@users.noreply.github.com> Co-authored-by: Kerbiter <crabiter@vivaldi.net>
Co-authored-by: Metadorius <Metadorius@users.noreply.github.com>
Thanks for advise. |
Docs/INISystem.md
Outdated
Width=25 ; integer, the Width of the control. | ||
Height=10 ; integer, the Height of the control. | ||
Size=60,30 ; 2 integers, the Width and Height of the control. | ||
Text=Some Text@Example ; text, the text to display for the control (ex: buttons, labels, etc...). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The values should contain default values or no values, if there is no default value. This will ensure that a config maker could copy-paste the reference INI code and have nothing changed in the behavior
Co-authored-by: Metadorius <Metadorius@users.noreply.github.com>
Co-authored-by: Kerbiter <crabiter@vivaldi.net>
Co-authored-by: Metadorius <Metadorius@users.noreply.github.com>
PR updates documentation style and makes significant improvement in
INISystem.md
file.Changelog:
**Note**
replaced to[!NOTE]
[!WARNING]