"Missing examples" when examples are enforced in fp-ts-std about docs-ts HOT 10 CLOSED

@thought2 - That was my thought process as well. Especially for libraries that can be complex to get started with. A great example would be the port of Haskell's scalpel web scraping library that I have been working on (link for those that are interested in taking a closer look).

However, since @gcanti, @gillchristian, and @samhh feel that this is not the direction to go I am also fine with removing the top-level module requirement for documentation when enforceExamples is set to true. Hopefully the fact that we are enforcing examples everywhere else in the code when this flag is turned on will encourage devs to put top-level examples as well 😅.

@gillchristian - since I know that the issue needs to be addressed in two places, I am already working on a PR. Should be submitting shortly.

from docs-ts.

My guess is that is detecting a missing example in the module documentation (i.e. the very first comment at the top of the module)

from docs-ts.

I agree with point 1. (not a desirable behaviour for examples)

from docs-ts.

I'm fine with either way :)

However, I find it somehow appealing to also enforce examples on the module level if this option is enabled.
It encourages you think about the module as if you've never heard of it before.

Maybe to put a selection of some representative functions that the module provides into a pipe.

For Array e.g.:

import * as A from 'fp-ts/Array'
import { pipe } from 'fp-ts/function'

const sample : Array<string> = pipe(
  [1, 2, 3, 4],
  A.filter((n) => n >= 2),
  A.map((n) => n.toString())
)

assert.deepStrictEqual(sample, ['3', '2'])

from docs-ts.

Hmm, I hadn't even considered that. Is that desirable behaviour?

from docs-ts.

@gcanti is correct - the parser is detecting missing documentation at the module level. See here:

As a side note, we decided to go this route based on the discussion in #23.

More than happy to discuss further.

from docs-ts.

Gotcha. I've two pieces of feedback then depending on where we want to go with it:

1. I don't consider this desirable behaviour for examples specifically. What's an appropriate example for an "Array" module? I can't think of one, but I'd like to enforce examples for all exports. If deemed actionable I suppose there's a few ways to solve this though I can't think of one that's obviously ideal.
2. If this won't be actioned in terms of configuration options, could the parser error be improved? It's extremely vague.

from docs-ts.

@gcanti, @gillchristian, @thought2 - do you guys have any opinion on how to solve this issue?

from docs-ts.

Agree, we should not enforce examples on module level docs.

I can work on this tonight. Unless somebody wants to give it a shot.

from docs-ts.

Another option could be to add an extra configuration to enforce module examples separately from the other examples.

Not sure if it's the road we want to go and keep populating the config tho 😬

from docs-ts.