Git Product home page Git Product logo

Comments (2)

Octachron avatar Octachron commented on August 17, 2024 3

Overall, I think that all tutorials would need to be edited. Another piece from the label tutorial:

When and when not to use ~ and ?

The syntax for labels and optional arguments is confusing, and you may often wonder when to use ~foo, when to use ?foo and when to use plain foo. It's something of a black art which takes practice to get right.

I cannot disagree more with the use of black art to try to instill a false sense of familiarity with the reader, at the price of sending a terrible and inaccurate message.

from v2.ocaml.org.

patricoferris avatar patricoferris commented on August 17, 2024

Hi @ninjaaron thanks for the feedback.

I completely agree, the phrase basic types is ambiguous (at least in this tutorial's context) and most I assume would be thinking of "basic data types" in the manual (see https://ocaml.org/releases/4.12/htmlman/coreexamples.html#s:datatypes), where using that definition this statement is indeed incorrect. Perhaps it would be better with a small explanation and then a link to https://ocaml.org/releases/4.12/htmlman/intfc.html#s:c-ocaml-datatype-repr ?

This is the second time in not so long that this tutorial seems to be incorrect/misleading (see ocaml/ocaml.org#1595) and I agree with @Octachron that overall the tone of the tutorial is not great. I'm wondering if it is causing more harm than good at this point?

from v2.ocaml.org.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.