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 Best Known Methods #107
Conversation
* Add a link to the Lists tutorial in the index page * Replace template variable in markdown
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apologies for the seemingly large review 🙈 ... most comments are just Opam -> opam
! After fixing some of these typos this looks good to add as an initial set of BKMs, thanks :))
@@ -140,7 +140,7 @@ val hello : unit -> unit | |||
|
|||
(note the double asterisk at the beginning of the comment - it is a good habit | |||
to document .mli files using the format supported by | |||
[ocamldoc](/releases/{{! get LATEST_OCAML_VERSION_MAIN !}}/htmlman/ocamldoc.html)) | |||
[ocamldoc](/releases/4.12.0/htmlman/ocamldoc.html)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm guessing once we have releases we could point this to /releases/latest
which redirects to the latest release we have?
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Co-authored-by: Patrick Ferris <pf341@patricoferris.com>
Thanks a lot for the thorough review @patricoferris!! |
This PR adds the Best Known Methods data and includes them on the Best Practices page.
The design is not final, I'll work on this in a follow-up PR.