Skip to content

Markdown Docstrings#28

Open
Lomand wants to merge 4 commits intodarklang:mainfrom
Lomand:md-docstrings
Open

Markdown Docstrings#28
Lomand wants to merge 4 commits intodarklang:mainfrom
Lomand:md-docstrings

Conversation

@Lomand
Copy link
Copy Markdown
Contributor

@Lomand Lomand commented Nov 11, 2023

Based on Rescript 11 branch.
Docs adapted to work with the new doc parser.
Some things still need to be resolved, like section headings, they are not working as intended (doc parser displays them instead of the actual function documentation.
I'll mark this as ready once I'll proofread the entire docs.
Screenshot from 2023-11-11 12-55-12
Screenshot from 2023-11-11 12-56-23

@Lomand Lomand force-pushed the md-docstrings branch 2 times, most recently from 0a03c5a to deb6fc1 Compare November 11, 2023 12:15
@Lomand
Copy link
Copy Markdown
Contributor Author

Lomand commented Jan 3, 2024

All the functions now have markdown docs, and they are displayed correctly in the IDE.
Unfortunately, section titles (Create, Iterate, etc) had to go since it was confusing Rescript compiler.
Interlinking between docs does not work (for now), I'll try to address this in a separate PR.

@Lomand Lomand marked this pull request as ready for review January 3, 2024 20:12
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.

1 participant