Skip to content

Improve docs #18

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

Merged
merged 1 commit into from
Jun 2, 2018
Merged

Conversation

Profpatsch
Copy link
Contributor

@Profpatsch Profpatsch commented May 22, 2018

Improves formatting & documents every symbol in the module. Depends on #16 (because otherwise a merge conflict is introduced).

@Profpatsch
Copy link
Contributor Author

I’d like to add some sections to the module, but it looks like the docs generator doesn’t support those at the moment?

@kritzcreek
Copy link
Contributor

Thanks for the docs, unfortunately the formatting changes cause all kinds of conflicts on the compiler/0.12 branch. Do you think you could rebase your work against that branch and remove the formatting changes (The signatures got a lot shorter with the effect rows disappearing, and we don't do the double newline between declarations anywhere else)

@kritzcreek
Copy link
Contributor

My plan is basically to add these changes to #20 and then use that to cut a new release :)

Every exposed symbol should be documented now.
@Profpatsch
Copy link
Contributor Author

@kritzcreek Done!

@kritzcreek kritzcreek changed the base branch from master to compiler/0.12 June 2, 2018 07:19
@kritzcreek
Copy link
Contributor

Awesome, Thank you very much!

@kritzcreek kritzcreek merged commit 3271efc into purescript-node:compiler/0.12 Jun 2, 2018
@kritzcreek kritzcreek mentioned this pull request Jun 2, 2018
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