Sha256: 04a1a2b7bbad94297698914e00de091092f07259d2be09586b2c2e64667ce85c

Contents?: true

Size: 743 Bytes

Versions: 3

Compression:

Stored size: 743 Bytes

Contents

# TODOs

* Recognize all relevant options in .yardopts file
  * --plugin
  * --[no-]api API
* Provide reusable context that filters code objects according to the
  visibility options
* Add support for multiple signatures for methods
  (realized via the @overload tag in YARD)

* Think about implicit cases in terms of evaluation:
  * constructors and ?-methods are automatically assigned a @return tag
  * attr_* methods are automatically assigned a docstring and @param tag

* Think about limiting the number of `B`-objects in `inch suggest`
  `inch suggest` shows too many `B`s even though there are still undocumented
  objects in the codebase. this becomes a problem, when one thinks of `B` as
  "good enough", which Inch itself suggests.

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
inch-0.2.2 TODOS.md
inch-0.2.1 TODOS.md
inch-0.2.0 TODOS.md