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

Documentation is out of sync with the latest release #171

Closed
ccapndave opened this issue Jul 23, 2020 · 13 comments
Closed

Documentation is out of sync with the latest release #171

ccapndave opened this issue Jul 23, 2020 · 13 comments

Comments

@ccapndave
Copy link

ccapndave commented Jul 23, 2020

The documentation shows functions such as Result.ok, Result.error and Option.both which don't actually exist in 0.0.7. It would be nice if the documentation had a version selector (maybe similar to Elixir's docs - https://hexdocs.pm/phoenix/Phoenix.html) so that you can choose master or 0.0.7.

On a side note I would like to use the functions in master, but I can't figure out how to get them working. Putting "tablecloth-bucklescript": "darklang/tablecloth#master" into package.json doesn't seem to work. Any advice would be appreciated!

@Dean177
Copy link
Collaborator

Dean177 commented Jul 23, 2020

The next release will happen really soon, I just need to get around to writing the changelog.

I think a version selector is a good idea, if we couple adding a new functions with a since x.y.z annotation in the docs it shouldn't be too much work to implement either, can you create a separate issue for the feature request?

Are you getting any specific errors when trying to use the latest master?

The integration-test folder always gets built and run against master, maybe that would be useful to check your configuration against?

@ccapndave
Copy link
Author

Sure! #172

The whole thing just failed to build with a lot of strange errors (Cannot find module Tablecloth, Cannot find module React). Do you think it should work if I add "tablecloth-bucklescript": "darklang/tablecloth#master" to the dependencies?

@Dean177
Copy link
Collaborator

Dean177 commented Jul 23, 2020

The format looks correct to me.

Perhaps try bsb -clean-world followed by bsb -make-world

@ccapndave
Copy link
Author

I had another go, and I think the problem is that there is a compile error that is preventing Tablecloth from compiling, which then causes subsequent errors:

  Warning number 3 (configured as error)
  /Users/dave/Projects/Couloir/ctp/title-cp/node_modules/tablecloth-bucklescript/bucklescript/src/TableclothInt.ml 45:29-43

  43 │ let ( /. ) n by = Js.Int.toFloat n /. Js.Int.toFloat by
  44 │
  45 │ let power ~base ~exponent = Js.Math.pow_int ~base ~exp:exponent
  46 │
  47 │ let ( ** ) base exponent = Js.Math.pow_int ~base ~exp:exponent

  deprecated: Js.Math.pow_int
use `power_float` instead, the return type may be not int

  Warning number 3 (configured as error)
  /Users/dave/Projects/Couloir/ctp/title-cp/node_modules/tablecloth-bucklescript/bucklescript/src/TableclothInt.ml 47:28-42

  45 │ let power ~base ~exponent = Js.Math.pow_int ~base ~exp:exponent
  46 │
  47 │ let ( ** ) base exponent = Js.Math.pow_int ~base ~exp:exponent
  48 │
  49 │ let negate = ( ~- )

  deprecated: Js.Math.pow_int
use `power_float` instead, the return type may be not int

@Dean177
Copy link
Collaborator

Dean177 commented Jul 30, 2020

It looks like you might be using a globally installed version of bsb?

We don't support anything more than 7.2.2 at the moment: #141

Try using the locally installed version using the scripts in package.json

npm run clean
npm run build

@ccapndave
Copy link
Author

Does that mean that my application has to use 7.2.2 too, or can Tablecloth be compiled with 7.2.2 but I can still use it in an 8.1.1 app?

@Dean177
Copy link
Collaborator

Dean177 commented Jul 30, 2020

I means that your app has to use 7.2.2 too.

#141 is the only issue stopping us from supporting a newer version of Bucklescript I think.

@ccapndave
Copy link
Author

Ah ok - I'm keen to change over to the new Bucklescript syntax so I'll stay on 8.2.2 and wait for a Tablecloth update in that case. Cheers!

@danielo515
Copy link

So all the documentation that I have been reading for more than one hour is basically useless? I want to use the Map.String module and I'm getting an error telling me that such module does not exist, then I checked the mli files and indeed there is no definition for that.

@pbiggar
Copy link
Member

pbiggar commented Aug 24, 2020

Apologies @danielo515, we need to get a release out. Can you use git master directly in your app?

@danielo515
Copy link

Don't worry @pbiggar, I'm using reason standard for now. Since most of the docs seems to come from there it is probably a good substitute for many. I'll be looking for the release (with standard merged in)

@pbiggar
Copy link
Member

pbiggar commented Oct 11, 2022

Actually released 0.0.8 and the website matches.

@pbiggar pbiggar closed this as completed Oct 11, 2022
@ccapndave
Copy link
Author

This is so weird - I was working on this project today for the first time in 2 years!

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

No branches or pull requests

4 participants