Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs.NoMissing: Add more configuration options #15

Open
jfmengels opened this issue Sep 25, 2021 · 3 comments
Open

Docs.NoMissing: Add more configuration options #15

jfmengels opened this issue Sep 25, 2021 · 3 comments

Comments

@jfmengels
Copy link
Owner

This is an issue to gather feedback and ideas.

The Docs.NoMissing rule has some configuration options that I think would work fine for packages, but probably not so much for application projects.

I can't imagine that some projects will require documentation for all functions and types in their project, but there is no concept of exposed modules there, so either this rule will be used there with a lot of ignoreRuleFor*, or it needs more configuration options.

I'm imagining a list of explicit modules or explicit directories, kind of like the following, though I'm not sure this will be sufficient either.

rule =
	{ document = everything
	, from =
        [ moduleNamed "Some.Module"
        , modulesUnder "Some.Folder"
        ]
    }

Alternatively, the rule could take a function ModuleName -> Bool that acts as a predicate, which would be very configurable but also potentially a bit annoying to configure.

I would love to see what options you'd like to have and/or what you think is best!

@gampleman
Copy link
Contributor

I would quite like it to allow blank documentation for types. The main motivating example is:


someFunction : List Attribute -> RequiredInput -> Result

type Attribute

foo : Attribute 

bar : Int -> Attribute

there really isn't a whole lot to say about this type.

@jfmengels
Copy link
Owner Author

Sorry, I'm not sure what you mean, can you clarify a bit more? Which type are you referring to?

@gampleman
Copy link
Contributor

gampleman commented Aug 15, 2023

The Attribute type in the example. Often times it's fairly impossible to say anything about a type when you have both the consumers and producers well documented without really excessive repetition ("can be constructed with foo or bar and used in someFunction") or terrible triteness ("used to pass optional attributes to functions").

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants