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

tools: docstring for nested submodules #897

Merged
merged 2 commits into from
Jan 22, 2024

Conversation

aspeddro
Copy link
Contributor

@aspeddro aspeddro commented Jan 21, 2024

The output doesn't print docstrings for nested submodules in interface files.

Example: API Docs for Core.Math.Constants

Now

dune exec -- rescript-tools doc ~/Desktop/projects/rescript-core/src/Core__Math.res | head
{
  "name": "Core__Math",
  "docstrings": ["Functions for interacting with JavaScript Math.\nSee: [`Math`](https://developer.mozil
la.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math)."],
  "items": [
  {
    "id": "Core__Math.Constants",
    "name": "Constants",
    "kind": "module",
    "docstrings": ["Mathematical Constants"],

Other Change

  • Print deprecated field for module

@zth
Copy link
Collaborator

zth commented Jan 22, 2024

Great!

@zth zth merged commit a9e1e18 into rescript-lang:master Jan 22, 2024
5 checks passed
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.

2 participants