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

Doc improvements #4782

Merged
merged 8 commits into from
Aug 5, 2021
Merged

Doc improvements #4782

merged 8 commits into from
Aug 5, 2021

Conversation

kit-ty-kate
Copy link
Member

@kit-ty-kate kit-ty-kate commented Aug 3, 2021

The change of the advised way to call install.sh was proposed in ocaml/platform-blog#77 and includes:

  • <() is a bash syntax, so people using this command in sh or csh will see the command fail
  • curl without -fS will output things in stdout when something goes wrong (404, and other network failure) and can cause random shell commands being executed. This is what https://brew.sh/ recommend for instance.

@rjbou rjbou added this to PR in Out of release : doc, test, install, etc. via automation Aug 4, 2021
@rjbou
Copy link
Collaborator

rjbou commented Aug 4, 2021

  • update of readme badges, release instructions, changelog for api follow-up

Copy link
Member

@dra27 dra27 left a comment

Choose a reason for hiding this comment

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

One, or possibly two, typos but otherwise LGTM!

master_changes.md Outdated Show resolved Hide resolved
master_changes.md Outdated Show resolved Hide resolved
@kit-ty-kate kit-ty-kate merged commit 9dca548 into ocaml:master Aug 5, 2021
Out of release : doc, test, install, etc. automation moved this from PR to done Aug 5, 2021
@kit-ty-kate kit-ty-kate deleted the doc-improvements branch August 5, 2021 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants