Private polymorphic variant extension output shows hidden row type
Nobody has claimed this yet.
- Dominant language
- OCaml
- Stars
- 355
- Forks
- 114
- Avg merge
- 6d 21h
- Merged PRs (30d)
- 10
Description
...at least, that's what I assume it is.
This code in test/html/cases/type.mli:
produces this output, in test/html/expect/test_package+ml/Type/index.html:
type private_extension#row
and private_extension = private [>
| polymorphic_variant
]
@lpw25 and/or @trefis, I assume this ...#row type is normal. Is fixing this issue just a matter of detecting the type, hiding it, and printing type where we now print and?
Is this something that should be handled when we first load the signature?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with test/html/cases/type.mli and the corresponding section of test/html/expect/test_package+ml/Type/index.html. Trace how this signature is loaded and rendered, confirming whether the private_extension#row entry is expected. Done means the generated HTML no longer exposes the hidden row type and uses the correct declaration form.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ocaml
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100