Add manual #78
Merged
Add manual #78
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Great! I read rapidly the manual-ocamlbuild thread, and it should definitely go to this repository. Just could you add a commit that moves the Thanks to all the participants! |
Same story: in order to reflect filenames listed just above
Explain use of Options.use_ocamlfind in myocamlbuild.ml instead of -use-ocamlfind command line option
wish build -> wish to build
…d' for the executable
I’m not certain this is a grammar error, but it feels like one because the two clauses of the “and” do not have the same structure.
Technically there was no grammar error, but there didn’t seem to be any benefit to avoiding multiple sentences. Originally I was going to replace the en dash with an em dash, but then realized it could just be a new sentence.
My fix is what I suspect you intended, use of em dashes to insert a parenthetical statement.
I’m not enough of a linguist to know which language rule is being broken here, but I suspect “those” is incorrect here.
I try to avoid starting sentences with lowercase words. This isn’t always possible, but I think it is here.
* Replace Markdown with Asciidoctor markup. * Make a distinct CONTRIBUTING.adoc document, following GitHub conventions. * Use a tabular presentation in manual where more appropriate than past presentation. * Add a directory for incomplete code samples, samples/. * First work towards sourcing incomplete code samples instead of including them verbatim in the manual text. * Be more consistent in use of `ocamlbuild` vs. OCamlbuild. For any tool now, `tool` is used when the CLI utility is meant vs. Tool when software product as a whole is meant. * Add TODO comments in manual for existing parts that need expert attention.
(with Changes from Gabriel Scherer)
|
Thanks for the feedback, I updated and moved the CONTRIBUTING document, I'll merge. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This merges
https://github.com/gasche/manual-ocamlbuild/
under a new
manualsubdirectory.