This Forum has been archivedVisit the new Forums
I'm planning on filling out the Cvar pages, but in looking at them, I've noticed theres no real standardization for them - some have only a sentence or two, with no examples, no explanation as to settings, but aren't marked as api stubs, as they're not reallly API, but still should be marked as a stub of some sort. Checked existing boilerplates, but the closest (API one) really doesn't fit well - they don't return information like APIs do, and changes are constantly made to the cvars - adding, breaking, expanding, fixing, etc, which could be helpful if it could be tracked.
For example, Blizzard broke gxRefresh in 3.2.0 so the only setting which worked was 60Hz. It may be helpful to track changes like this so if someone goes looking for why this setting resets itself to 60Hz, they can understand why.
So, I'm thinking first should be a section which will state not to change from the default - which will be used sparingly - some cvars really shouldn't be touched unless a GM tells you to - example M2Faster. Then, an introduction which tells what the cvar does, or is supposed to do. 1 or 2 sentences should be more than enough to explain what it does, a new section for current issues so its front & center that the cvar is currently bugged or performing improperly, a new section with an example which shows the default setting, followed by all the settings and what each setting does, and then a new section to track patch changes, and lastly any references/citations.