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

Update README with mli compatibility and dune stanza reference #370

Merged
merged 6 commits into from
Mar 1, 2022
Merged

Update README with mli compatibility and dune stanza reference #370

merged 6 commits into from
Mar 1, 2022

Conversation

NathanReb
Copy link
Contributor

This is a temporary update until we get the manual in #355 merged.

@NathanReb
Update README with mli compatibility and dune stanza reference
4a0b817 
This is a temporary update until we get the manual in realworldocaml#355 merged

Signed-off-by: Nathan Rebours <[email protected]>
@NathanReb NathanReb added the no changelog This PR doesn't require a changelog update label Feb 28, 2022
@NathanReb
Copy link
Contributor Author

Argh the cmdliner thing again. I think this is safe to merge even though ocaml-ci's red since it's just a README update!

@Leonidas-from-XIV
Copy link
Collaborator

Yeah, I noticed the problem when I submitted #369. Might as well fix it so I opened #371.

@samoht
Copy link
Collaborator

samoht commented Feb 28, 2022

Could you also explain how to use the mli feature?

@Leonidas-from-XIV
Copy link
Collaborator

Rebasing should fix CI, we fixed the Cmdliner breakage.

@NathanReb
Copy link
Contributor Author

Just imported the first section of the manual incorporating @christinerose's review. I added an mli example there. In addition to the existing example of mli syntax for labels this should cover the basics until the manual is ready.

Leonidas-from-XIV
Leonidas-from-XIV approved these changes Feb 28, 2022
View reviewed changes
Copy link
Collaborator

@Leonidas-from-XIV Leonidas-from-XIV left a comment

Choose a reason for hiding this comment

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

Very good improvements. I like how it fixes larger bits instead of just adding a sentence here and there so the actual readability is improved.

README.md Show resolved Hide resolved
samoht
samoht reviewed Feb 28, 2022
View reviewed changes
README.md Show resolved Hide resolved
@samoht
Copy link
Collaborator

samoht commented Feb 28, 2022

Just a minor comment but otherwise looks really great!

1 similar comment
@samoht
Copy link
Collaborator

samoht commented Feb 28, 2022

Just a minor comment but otherwise looks really great!

@NathanReb
Copy link
Contributor Author

I also removed redundant and out of date sections or wording.

@samoht
Copy link
Collaborator

samoht commented Mar 1, 2022

Looks great, thanks

@samoht samoht merged commit daf23ed into realworldocaml:main Mar 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@samoht samoht samoht left review comments

@Leonidas-from-XIV Leonidas-from-XIV Awaiting requested review from Leonidas-from-XIV

Assignees
No one assigned
Labels
no changelog This PR doesn't require a changelog update
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@NathanReb @Leonidas-from-XIV @samoht