Skip to content

Docgen from compiler #764

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

Merged
merged 17 commits into from
Jan 10, 2024
Merged

Docgen from compiler #764

merged 17 commits into from
Jan 10, 2024

Conversation

aspeddro
Copy link
Collaborator

@aspeddro aspeddro commented Dec 18, 2023

This PR depends:

TODO:

  • Update tests

@zth zth self-requested a review December 18, 2023 19:48
Copy link
Collaborator

@zth zth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can I authorize deploy now?

@zth zth self-requested a review December 18, 2023 19:49
Copy link
Collaborator

@zth zth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving to see if I can authorize.

@fhammerschmidt
Copy link
Member

What's the state of this?

@aspeddro
Copy link
Collaborator Author

I'm still working on the UI

@aspeddro
Copy link
Collaborator Author

aspeddro commented Jan 2, 2024

Ready for review

@cknitt
Copy link
Member

cknitt commented Jan 2, 2024

Great stuff! 🎉 👍

A few minor things I noticed while trying it out:

  • The new API docs show up under "v8.2.0", replacing the previous contents there. Shouldn't we leave the previous contents and add the new stuff under "v11.0.0"?
  • Some internal modules are now there that weren't shown before (Js.Internal, Js.MapperRt). These should probably be suppressed somehow.
  • NullUndefined is now Null_undefined.
  • It's TypedArray2, but Typed_array, and there are Float64_array and Float64Array etc.
  • The Dom module exports too much stuff (both htmlDocument and _htmlDocument etc.).

@aspeddro
Copy link
Collaborator Author

aspeddro commented Jan 4, 2024

The new API docs show up under "v8.2.0", replacing the previous contents there. Shouldn't we leave the previous contents and add the new stuff under "v11.0.0"?

It's like this on the master, I don't know why

Some internal modules are now there that weren't shown before (Js.Internal, Js.MapperRt). These should probably be suppressed somehow.

We can suppress these modules

NullUndefined is now Null_undefined.

Yes, the most current state of this PR shows the module Null_undefined

It's TypedArray2, but Typed_array, and there are Float64_array and Float64Array etc.

I didn't understand this point

The Dom module exports too much stuff (both htmlDocument and _htmlDocument etc.).

I don't know what we should do about this, I think it's better to keep

@aspeddro
Copy link
Collaborator Author

aspeddro commented Jan 6, 2024

  • Tests updated cec8c48
  • Js.Internal and Js.MapperRt suppressed d80ca3b

@aspeddro
Copy link
Collaborator Author

aspeddro commented Jan 6, 2024

Dropdown menu fixed.
image

@aspeddro aspeddro requested a review from zth January 6, 2024 22:20
@cknitt
Copy link
Member

cknitt commented Jan 7, 2024

Just noticed something else regarding the new layout with the types and values in a column on the right:

Bildschirmfoto 2024-01-07 um 10 12 06

If the screen width is insufficient, that column disappears altogether:

Bildschirmfoto 2024-01-07 um 10 12 26

This seems not ideal compared to the old solution:

Bildschirmfoto 2024-01-07 um 10 13 08

@cknitt cknitt merged commit 87f3a59 into rescript-lang:master Jan 10, 2024
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

Successfully merging this pull request may close these issues.

4 participants