Skip to content

Updates to doc comments, and export to make doc gen work#28

Merged
rtfeldman merged 5 commits intoroc-lang:mainfrom
lukewilliamboswell:docs
Jun 10, 2023
Merged

Updates to doc comments, and export to make doc gen work#28
rtfeldman merged 5 commits intoroc-lang:mainfrom
lukewilliamboswell:docs

Conversation

@lukewilliamboswell
Copy link
Collaborator

Minor updates to get docs generation working for basic-cli.

Screen Shot 2023-03-29 at 13 20 23

@Anton-4 I wasn't sure if there is a reason the modules aren't exposed in the platform main.roc. I added them anyway so docs generation would work. Please let me know if this is not right.

@lukewilliamboswell
Copy link
Collaborator Author

I hadn't noticed @rtfeldman PR #22 this does basically the same thing, but also add instructions to the README and some formatting edits to the modules Doc comments.

@Anton-4
Copy link
Collaborator

Anton-4 commented Mar 29, 2023

Can this be closed in favor of #22?

@Anton-4 I wasn't sure if there is a reason the modules aren't exposed in the platform main.roc

The reason was that it causes a build error 😄

@lukewilliamboswell
Copy link
Collaborator Author

If we merge #22 first, then I will update this so that when we generate the docs they look acceptable. There is a lot of missing doc comments, but at least what is there will be more useable.

@Anton-4
Copy link
Collaborator

Anton-4 commented Apr 21, 2023

I didn't notice it until later but it looks like the exposes issue is fixed?

@Anton-4
Copy link
Collaborator

Anton-4 commented Apr 21, 2023

It does appear to be stuck again on env again in #22, perhaps it's a flaky issue...

EDIT
I think it's because the exposes list is different in this PR.

Copy link
Contributor

@rtfeldman rtfeldman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, super excited about this!!! 😍 😍 😍

I added a couple of comments, but nothing blocking.

@rtfeldman rtfeldman merged commit 2ce4d9c into roc-lang:main Jun 10, 2023
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.

3 participants