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

Add developer docs on some things we do different than standard OCaml #1137

Merged
merged 3 commits into from
Mar 21, 2022

Conversation

WardBrian
Copy link
Member

This is related to #1134, but not quite enough to resolve it yet. It introduces some basic ideas about the jane street libraries, deriving functions, and the two-level types.

Submission Checklist

  • Run unit tests
  • Documentation
    • If a user-facing facing change was made, the documentation PR is here:
    • OR, no user-facing changes were made

Release notes

Improve developer documentation

Copyright and Licensing

By submitting this pull request, the copyright holder is agreeing to
license the submitted work under the BSD 3-clause license (https://opensource.org/licenses/BSD-3-Clause)

@WardBrian WardBrian added the documentation documentation for end-users and/or other devs label Feb 28, 2022
@WardBrian WardBrian requested a review from rok-cesnovar March 1, 2022 17:49
Copy link
Member

@rok-cesnovar rok-cesnovar left a comment

Choose a reason for hiding this comment

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

Some suggestions, otherwise 👍🏻

docs/core_ideas.mld Outdated Show resolved Hide resolved
docs/core_ideas.mld Outdated Show resolved Hide resolved
docs/core_ideas.mld Outdated Show resolved Hide resolved
docs/core_ideas.mld Outdated Show resolved Hide resolved
docs/core_ideas.mld Outdated Show resolved Hide resolved
docs/core_ideas.mld Outdated Show resolved Hide resolved
@WardBrian WardBrian requested a review from rok-cesnovar March 21, 2022 13:27
Copy link
Member

@rok-cesnovar rok-cesnovar left a comment

Choose a reason for hiding this comment

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

Great stuff!

@WardBrian WardBrian merged commit 900777c into master Mar 21, 2022
@WardBrian WardBrian deleted the dev-docs-quirks branch March 21, 2022 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation documentation for end-users and/or other devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants