language-servers/roc
1
0
Fork 0
mirror of https://github.com/roc-lang/roc.git synced 2025-07-29 01:13:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Update some comments and docs

Browse source
This commit is contained in:
Richard Feldman 2022-12-24 19:25:22 -05:00
parent 52bbe0062f
commit 5c80657bb2
No known key found for this signature in database
GPG key ID: F1F21AA5B1D9E43B
1 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
crates/compiler/load_internal/src/docs.rs
View file

@ -194,7 +194,7 @@ fn generate_entry_docs(
..
} => {
if let Pattern::Identifier(identifier) = ann_pattern.value {
// Check if the definition is exposed
// Check if this module exposes the def
if let Some(ident_id) = ident_ids.get_id(identifier) {
let doc_def = DocDef {
name: identifier.to_string(),
@ -237,6 +237,10 @@ fn generate_entry_docs(
}
let type_annotation =
// If this alias contains an unexposed type, then don't try to render a
// type annotation for it. You're not allowed to see that!
// (This comes up when exporting an alias like Task ok err : InnerTask ok err
// where Task is exposed but InnerTask isn't.)
if contains_unexposed_type(&ann.value, exposed_module_ids, module_ids) {
TypeAnnotation::NoTypeAnn
} else {
@ -332,6 +336,8 @@ fn generate_entry_docs(
acc
}
/// Does this type contain any types which are not exposed outside the package?
/// (If so, we shouldn't try to render a type annotation for it.)
fn contains_unexposed_type(
ann: &ast::TypeAnnotation,
exposed_module_ids: &[ModuleId],