Yes, the stdlib is in dire need of more documentation.

For the `options` module specifically I don't think documentation for specific 
procedures is what is needed. We need documentation at the top of each module 
explaining its purpose, along with small and specific examples (that are 
cook-book like). For example, see the httpclient docs: 
[https://nim-lang.org/docs/httpclient.html](https://nim-lang.org/docs/httpclient.html),
 these aren't perfect but they're a good start.

The one thing that you shouldn't do is add a large example in the docs that 
shows off various features of the module. It's not easy for readers to pick out 
the information they need that way.

> but some of the procs (e.g. isSome) are obvious

That's not true. Imagine a developer who has never used functional programming. 
They will likely have absolutely no idea how to use the `options` module.

Reply via email to