question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

`damlc docs` generates wrong links for Types from stdlib

See original GitHub issue

When using daml damlc docs to generate documentation from DAML code, types like Text (from stdlib) used to have a link leading to their description in the SDK documentation. Since SDK 1.1.0 the anchors in the links are not valid any more, the link only leads to the start page of the stdlib documentation. The split into separate files per module in https://github.com/digital-asset/daml/pull/5636 has probably caused this.

To see the issue, run the following commands:

$ daml new test-damldoc
$ cd test-damldoc
$ daml damlc docs daml/Maiin.daml -o test
$ cat test/Main.md

The generated Main.md will contain a link [Text](https://docs.daml.com/daml/stdlib/index.html#type-ghc-types-text-57703) which should instead be https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-57703

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:7 (7 by maintainers)

github_iconTop GitHub Comments

1reaction
sofiafaro-dacommented, Jun 24, 2020

@shayne-fletcher’s work in #6386 adds the --input-anchor flag and distributes the stdlib anchor table in the damlc runfiles. The only thing missing is to make the anchor table shipped with damlc be used by default.

0reactions
akrmncommented, Nov 4, 2022

While working on https://github.com/digital-asset/daml/pull/15446 I found that

The only thing missing is to make the anchor table shipped with damlc be used by default.

is still missing

Read more comments on GitHub >

github_iconTop Results From Across the Web

daml ledger export: path issue in data-dependencies #10378
I've been testing https://docs.daml.com/tools/export/index.html and I found an issue in the way that it generates data-dependencies.
Read more >
Release notes — DAML SDK 1.4.0 documentation
The DAML compiler will now compile type synonyms ( type X = Y ) ; You can now use daml new project-name --template=template-name...
Read more >
Table of Content generates wrong links - Google Docs Editors ...
Table of Content generates wrong links · Open a document. · Click Help > Report a problem. · Enter your feedback.
Read more >
How to use links in documentation - Contributor guide
The simplest way to create a relative link is to copy the URL from your browser, then remove https://learn.microsoft.com/en-us from the value ...
Read more >
Module link types - ServiceNow Docs
Link Type, Description. Assessment, Links to the assessment-based survey you select in the Assessment reference field. See Create a survey ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found