[Bro-Dev] Documenting Weirds

[Siwek, Jon]

On Jun 27, 2014, at 3:35 PM, Vlad Grigorescu <vlad at grigorescu.org> wrote:

> Is there a mechanism in Broxygen to document weirds? If not, has anyone thought about what such a mechanism might look like?

There’s not currently a mechanism.  Things that Broxygen can easily aid in documenting are tied to a script-layer name/symbol/identifier.  Weirds differ since they’re string values.

A suggestion would be to change weirds to use an enum instead of a string value.  That would then provide an identifier to hang documentation off of and also maybe help keep the core-analyzers in sync w/ scripts (e.g. there’s currently not a robust way to signify to a user that a weird was removed/changed and thus their scripts may become stale or possibly broken in the case of a rename).

- Jon