Documentation improvements

oUF-wow / oUF

WoW AddOn - Unit frame framework.

MIT License

222 stars 58 forks source link

Closed p3lim closed 3 years ago

p3lim commented 5 years ago

options are already optional, drop the ? from the type, suggesting something else than the type could be provided
when the option requires a specific value, explicitly note the value instead of the type
- e.g. ('asc'|'desc'|nil) instead of (string?) ['asc', 'desc'] (current)
- right-most type is the default value (typically nil)
types should be presented before the explanation of the option
- e.g. (string|nil) ... instead of ... (string?) (current)

We also need to (finally) export the documentation.

siweia commented 5 years ago

The doc in stagger may need to be improved as well. https://github.com/oUF-wow/oUF/blob/5a201c9afa0938d81e43a3cc7873561e5199ace1/elements/stagger.lua#L140 The UNIT_AURA can only be registered if you hide the stagger by default. It took me a while to figure out why my stagger bar was not updating.

Rainrider commented 5 years ago

Do not show/hide oUF elements by yourself, let oUF handle this.

siweia commented 5 years ago

If I follow the example doc in stagger, the bar won't be able to update. I have to add "Stagger:Hide()".

Rainrider commented 5 years ago

Nope, this is something I've broken here, it is not the docs. Will fix in about an hour.

Rainrider commented 5 years ago

The patch is pending approval and will be released shortly. I am sorry for the inconvenience it has caused you. Thanks for reporting it.

p3lim commented 5 years ago

Stupid GitHub trying to be smart...