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.

Sign up for GitHub

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

Jump to bottom

createDomain creates definitions without documentation #1674

Closed
martijnbastiaan opened this issue Feb 22, 2021 · 4 comments · Fixed by #1680
Closed

createDomain creates definitions without documentation #1674

martijnbastiaan opened this issue Feb 22, 2021 · 4 comments · Fixed by #1680
Labels
documentation external bug

Comments

@martijnbastiaan
Copy link
Member

This is an issue when trying to achieve 100% documentation coverage. E.g.:

  Missing documentation for:
    Core (src/Config.hs:11)
    vCore (src/Config.hs:11)
@alex-mckenna
Copy link
Contributor

Not much we can do for this right? Haddock's floating documentation doesn't let you attach docs to a specific entity I don't think, and we can't generate docs with TH currently. Unless you have some idea?

@martijnbastiaan
Copy link
Member Author

and we can't generate docs with TH currently.

Right, I forgot that. That's pretty annoying.

Haddock should probably get an option to locally disable specific warnings (and it should get a -Werror pff). Marking this external bug (external feature?) for now.

@christiaanb
Copy link
Member

GHC 9.2 will solve this, I think: https://gitlab.haskell.org/ghc/ghc/-/merge_requests/3330

@alex-mckenna
Copy link
Contributor

external bug (external feature?)

You say potato, I say 🥔

basile-henry added a commit that referenced this issue Feb 25, 2021
@basile-henry
Create domain alias/helper when they don't exit
1198442 
fixes #1674

This makes it possible to explicitly define the type alias (or the
helper). This can be useful when writing documentation for both.

For example:

```haskell
-- | MySystem is a custom domain ...
type MySystem = ("MySystem" :: Domain)

-- | vMySystem is is the domain configuration associated with `MySystem`
createDomain vSystem{vName="MySystem"}
```
basile-henry added a commit that referenced this issue Feb 25, 2021
@basile-henry
Create domain alias/helper when they don't exit
3aed58f 
fixes #1674

This makes it possible to explicitly define the type alias (or the
helper). This can be useful when writing documentation for both.

For example:

```haskell
-- | MySystem is a custom domain ...
type MySystem = ("MySystem" :: Domain)

-- | vMySystem is is the domain configuration associated with `MySystem`
createDomain vSystem{vName="MySystem"}
```
@basile-henry basile-henry mentioned this issue Feb 25, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation external bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Create domain alias/helper only when they don't exist clash-lang/clash-compiler
3 participants
@christiaanb @martijnbastiaan @alex-mckenna