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

We should document the fact that bigarray-access syntax needs "open Bigarray" in 4.03 #6885

Closed
vicuna opened this issue Jun 1, 2015 · 6 comments

Comments

@vicuna
Copy link

vicuna commented Jun 1, 2015

Original bug ID: 6885
Reporter: @gasche
Assigned to: @Octachron
Status: resolved (set by @Octachron on 2017-02-23T23:49:59Z)
Resolution: fixed
Priority: normal
Severity: text
Version: 4.03.0+dev / +beta1
Target version: later
Category: documentation
Tags: junior_job
Related to: #6139

Bug description

The bigarray access syntax is documented as an extension in the manual:

http://caml.inria.fr/pub/docs/manual-ocaml/extn.html#sec240

We should explicitly document the fact that, starting at 4.03, "open Bigarray" needs to be used for this syntax to be available for bigarrays. This is one of the breaking changes coming with 4.03.

There are discussions of having a tailored error message, or maybe even supporting the bigarray-syntax with a deprecated backward-compatibility mode for now, but in any case we should document "open Bigarray" as the proper long-term solution.

@vicuna
Copy link
Author

vicuna commented Jun 1, 2015

Comment author: @Octachron

Another problem with the current documentation in the manual is that the translation table between the (.{}) operators and the bigarray functions does no longer describe accurately the actual desugaring.

I think it might be better to document first the new syntax for index operators, and then details the specificities of the (.{}) operators family and its link with the bigarray library.

@vicuna
Copy link
Author

vicuna commented Jun 1, 2015

Comment author: @gasche

Certainly. Pull requests against

https://github.com/ocaml/ocaml-manual

are warmly welcome.

@vicuna
Copy link
Author

vicuna commented Jun 2, 2015

Comment author: @dbuenzli

Could we also have a Bigarray.Ops module to open ? Opening Bigarray brings in a lot of values in your scope.

@vicuna
Copy link
Author

vicuna commented Jun 2, 2015

Comment author: @dbuenzli

And since this formally breaks backward compatibility shouldn't this be taken as an opportunity to solve #6139 at the same time ?

@vicuna
Copy link
Author

vicuna commented Dec 2, 2015

Comment author: @alainfrisch

No longer relevant for 4.03.

@vicuna
Copy link
Author

vicuna commented Feb 23, 2017

Comment author: @Octachron

I am closing this as both no longer relevant, and fixed in the relevant branches/PR's.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants