waalge
/
aiken
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Properly display constructor arguments documentation, if any.

This commit is contained in:
KtorZ 2024-08-17 17:01:28 +02:00
parent 2bb2f11090
commit 802e8272c5
No known key found for this signature in database
GPG Key ID: 33173CB6F77F4277
2 changed files with 32 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
crates/aiken-project/src/docs.rs
View File

@ -553,6 +553,15 @@ struct DocTypeConstructor {
impl DocTypeConstructor {
fn from_record_constructor(constructor: &RecordConstructor<Rc<Type>>) -> Self {
let doc_args = constructor
.arguments
.iter()
.filter_map(|arg| match (arg.label.as_deref(), arg.doc.as_deref()) {
(Some(label), Some(doc)) => Some(format!("#### `.{label}`\n{doc}\n<hr/>\n",)),
_ => None,
})
.join("\n");
DocTypeConstructor {
definition: format::Formatter::new()
.docs_record_constructor(constructor)
@ -560,7 +569,7 @@ impl DocTypeConstructor {
documentation: constructor
.doc
.as_deref()
.map(render_markdown)
.map(|doc| render_markdown(&format!("{doc}\n{doc_args}")))
.unwrap_or_default(),
raw_documentation: constructor.doc.as_deref().unwrap_or_default().to_string(),
}

22
crates/aiken-project/templates/css/index.css
View File

@ -510,10 +510,32 @@ body.drawer-open .label-closed {
color: var(--color-background-accent);
}
.constructor-item-docs hr {
color: var(--color-text-accent);
}
.constructor-item-docs hr:last-child {
display: none;
}
.constructor-item-docs p {
margin: 0;
}
.constructor-item-docs h4 {
margin-bottom: 1rem;
display: inline-block;
}
.constructor-item-docs h4 > code {
padding: 0.5rem;
}
.constructor-item-docs h4 ~ p {
padding-left: 0.5rem;
display: inline-block;
}
.constructor-name {
box-shadow: unset;
margin: 0;