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

Incosistent minetest.conf.example #2850

Closed
PilzAdam opened this issue Jun 28, 2015 · 9 comments
Closed

Incosistent minetest.conf.example #2850

PilzAdam opened this issue Jun 28, 2015 · 9 comments
Labels
@ Documentation Trivial The change is a trivial bug fix, documentation or maintenance change, as per the Git Guidelines
Milestone

Comments

@PilzAdam
Copy link
Contributor

Some settings in minetest.conf.example have their description under and not above them.

@PilzAdam PilzAdam added @ Documentation Trivial The change is a trivial bug fix, documentation or maintenance change, as per the Git Guidelines labels Jun 28, 2015
@est31
Copy link
Contributor

est31 commented Jun 28, 2015

Yes, I'd like it to be description-above-setting too.

@RealBadAngel
Copy link
Contributor

For me more sense makes description below the setting.

@kilbith
Copy link
Contributor

kilbith commented Jun 29, 2015

The description is never before the words in the dictionaries. It's just common sense : you don't describe something that you don't have yet named or introduced (else it's confusing).

@bdjnk
Copy link

bdjnk commented Jun 30, 2015

In every config file I know of, the description is above the setting. This is also true in programming, where the documentation comments always come before the code

@SmallJoker
Copy link
Member

I prefer when it's like in the lua_api.txt fle, description below the setting.

@Calinou
Copy link
Member

Calinou commented Jun 30, 2015

Description above the setting, because it is a standard in eg. php.ini.

@PilzAdam
Copy link
Contributor Author

@RealBadAngel this is not a discussion how it should be. Also in the future just stay with the conventions we already use instead of silently doing your own stuff.

@est31 est31 added this to the 0.4.13 milestone Jun 30, 2015
@paramat
Copy link
Contributor

paramat commented Jul 4, 2015

Yes, additions should follow the majority of entries: description above. Shaders settings are currently reversed.

@ShadowNinja
Copy link
Member

6c5bc14

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@ Documentation Trivial The change is a trivial bug fix, documentation or maintenance change, as per the Git Guidelines
Projects
None yet
Development

No branches or pull requests

9 participants