language-servers/roc
1
0
Fork 0
mirror of https://github.com/roc-lang/roc.git synced 2025-08-04 04:08:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Always generate doc links to builtins

Browse source
This commit is contained in:
Richard Feldman 2022-12-24 10:47:14 -05:00
parent 3f0060f492
commit b9f8253c39
No known key found for this signature in database
GPG key ID: F1F21AA5B1D9E43B
1 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
crates/docs/src/lib.rs
View file

@ -742,9 +742,17 @@ fn doc_url<'a>(
Some(module_id) => {
let symbol = interns.symbol(module_id, ident.into());
if symbol.is_builtin() {
// We can always generate links for builtin modules.
// TODO add a `--include-builtins` CLI flag for generating offline docs locally
// which include builtins; if that flag is omitted, have this code path generate
// a link directly to the builtin docs on roc-lang.org instead of to a localhost
// URL that will 404.
module_name = symbol.module_string(interns);
}
// Note: You can do qualified lookups on your own module, e.g.
// if I'm in the Foo module, I can do a `Foo.bar` lookup.
if !all_exposed_symbols.contains(&symbol) {
else if !all_exposed_symbols.contains(&symbol) {
// TODO return Err here
panic!(
"Tried to generate an automatic link in docs for `{}.{}`, but `{}` does not expose `{}`.",