Make sure to write good documentation

#1

For example this is bad practice:

  /**
   * Check if a value is void or not
   * return true if a container object (stream, collection, map, json, binary, string) has no contents
   */
  isVoid: function(value: !?any): boolean

  isNotVoid: function(value: !?any): boolean

A user finding isNotVoid through documentation will not see the documentation for isVoid (they only appear together in the source code for the type).

1 Like