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

first draft of doc comments #112

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

first draft of doc comments #112

wants to merge 2 commits into from

Conversation

FayCarsons
Copy link
Collaborator

No description provided.

Sudha247
Sudha247 requested changes Feb 28, 2024
View reviewed changes
Copy link
Owner

@Sudha247 Sudha247 left a comment

Choose a reason for hiding this comment

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

Thanks! Did you mean to add the doc comments to .mli files rather than in the .ml files? The API docs are included in the interface files, and odoc generates HTML files from them.

@FayCarsons
Copy link
Collaborator Author

Thanks! Did you mean to add the doc comments to .mli files rather than in the .ml files? The API docs are included in the interface files, and odoc generates HTML files from them.

Oops, I had just assumed it works like other languages I've used. Will move those today!

@FayCarsons
Copy link
Collaborator Author

@Sudha247 Moved everything to joy.mli, I figured since that's all that's exposed then that's all that needs documentation but please let me know if I'm wrong.

Sudha247
Sudha247 approved these changes Apr 13, 2024
View reviewed changes
Copy link
Owner

@Sudha247 Sudha247 left a comment

Choose a reason for hiding this comment

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

Thanks!

@Sudha247
Copy link
Owner

I'll fix the conflicts and merge this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Sudha247 Sudha247 Sudha247 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@FayCarsons @Sudha247