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.

Sign up for GitHub

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

Jump to bottom

References in doc strings #25

Closed
dbuenzli opened this issue Sep 20, 2016 · 2 comments
Closed

References in doc strings #25

dbuenzli opened this issue Sep 20, 2016 · 2 comments
Labels
output

Comments

@dbuenzli
Copy link
Contributor

dbuenzli commented Sep 20, 2016 •
edited
Loading

are not hyperlinked and references to identifiers not wrapped in a code tag.

Contrast the links in the preamble of this module:

http://docs.mirage.io/odoc/astring/Astring/index.html
http://docs.mirage.io/astring/Astring.html

Contrast the doc string of the two first values in the String section here:

http://docs.mirage.io/odoc/astring/Astring/index.html
http://docs.mirage.io/astring/Astring.html
@dbuenzli dbuenzli changed the title References to identifiers in doc strings References in doc strings Sep 20, 2016
@trefis
Copy link
Contributor

trefis commented Dec 13, 2016

The first part of the issue is that odoc doesn't handle "forward references" correctly, this is blocked on @lpw25 rewrite of parts of doc-ock.

The second part (the doc string being incorrect) I will fix today.

trefis added a commit to ocaml-doc/doc-ock-html that referenced this issue Dec 14, 2016
@trefis
fix reference text being lost (cf. ocaml/odoc#25)
a909183
@trefis trefis removed the output label Dec 15, 2016
@trefis
Copy link
Contributor

trefis commented Dec 15, 2016

I misread the odoc file, the reference is resolved and the problem is indeed in doc-ock-html, I will fix this.

dbuenzli added a commit to dbuenzli/odoc that referenced this issue Dec 18, 2018
@dbuenzli
Cli: be more lenient with directory existence.
6e6b3a4 
Do not require -I directories to exist in `compile` command
(closes ocaml#25). Do not require the -o directory to exist in
`*-targets` commands (closes ocaml#170).
@dbuenzli dbuenzli mentioned this issue Dec 18, 2018
Merged
jonludlam pushed a commit to jonludlam/odoc-parser-cleaned that referenced this issue Jul 1, 2021
@trefis
fix reference text being lost (cf. ocaml/odoc#25)
df82dee
jonludlam pushed a commit to jonludlam/odoc-parser-cleaned that referenced this issue Jul 1, 2021
@trefis
Rework URLs (and anchors).
8ffa606 
There are still a few ugly points in the code, but the produced html should now
be correct.
So I think we can say this commit
- fixes ocaml/odoc#23
- fixes ocaml/odoc#25
Julow pushed a commit to Julow/odoc that referenced this issue Dec 11, 2024
@art-w
Merge pull request ocaml#25 from art-w/remove_weird_warnings
77ecc82 
remove weird warnings
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
output
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@trefis @dbuenzli