| View Issue Details [ Jump to Notes ] | [ Issue History ] [ Print ] |
| ID | Project | Category | View Status | Date Submitted | Last Update |
| 0005612 | OCaml | OCaml documentation | public | 2012-05-10 10:13 | 2012-09-21 14:20 |
|
| Reporter | gasche | |
| Assigned To | gasche | |
| Priority | low | Severity | text | Reproducibility | N/A |
| Status | assigned | Resolution | open | |
| Platform | | OS | | OS Version | |
| Product Version | | |
| Target Version | 4.01.0+dev | Fixed in Version | | |
|
| Summary | 0005612: Rationalize spacing and parenteses use in the tutorial part of the manual |
| Description | A beginners_list discussion revealed that some beginners are confused by the spacing style used in the introduction, that plays a dubious ambiguity between OCaml parenthesing rules and the more familiar f(x) notation. Terms like fib(n-2) or square(cos pi) are a potential recipe for disaster once the beginner uses currified functions.
In my experience, such parenthesing and escaping mistakes are actually the number one problem among early OCaml beginners. This section of the manual should be updated to avoid that style. |
| Tags | No tags attached. |
|
| Attached Files | |
|
Relationships 
Relationships 