oUF

Addons
97.2k Downloads

Documentation improvements

p3lim opened this issue ยท 6 comments

commented
  • 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.

commented

Stupid GitHub trying to be smart...

commented

The doc in stagger may need to be improved as well.

oUF/elements/stagger.lua

Line 140 in 5a201c9

if(not self.Stagger:IsShown()) then

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.

commented

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

commented

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

commented

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

commented

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