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

Fix #454, Remove (..) from types in @docs #565

Merged
merged 1 commit into from
Oct 8, 2018

Conversation

mdevlamynck
Copy link
Contributor

Fixes #454.

This adds a cleanup pass before rendering the module docs content. It removes (..) if any in the Markdown.ElmDocs.

I'm not sure if this is the best place to put this pass but I figured if it's done in the formatting function it will not break other stuff and will not miss any (..) it's supposed to remove.

I'm not very familiar with haskell so my Text.replace (Text.pack "(..)") (Text.pack "") thing might not be the best way of doing this.

@avh4
Copy link
Owner

avh4 commented Oct 8, 2018

This looks good, thanks!

A possible improvement would be to instead put the code in the markdown parser so that the invalid characters are stripped out of the AST representation. But given that the markdown parser is forked from another project and is quite confusing, I'm not sure it would be easy to do that way.

@avh4 avh4 added this to the 0.8.2 CLI updates milestone Oct 8, 2018
@avh4 avh4 merged commit abe730a into avh4:master Oct 8, 2018
@avh4
Copy link
Owner

avh4 commented Oct 8, 2018

@mdevlamynck oh, can you also add a line for yourself at the bottom of the list of authors in LICENSE, and make a PR indicating that you are licensing your contributions to this project under that BSD 3-Clause license

@mdevlamynck mdevlamynck deleted the pr-remove-illegal-wildcard-docs branch October 20, 2018 11:52
kutyel pushed a commit to kutyel/elm-format that referenced this pull request Apr 26, 2022
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

Successfully merging this pull request may close these issues.

2 participants