akanealw/misode.github.io
1
0
Fork 0
mirror of https://github.com/misode/misode.github.io.git synced 2026-04-26 08:26:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Change doc comments to be based on field instead of hover

Browse Source
This commit is contained in:
Misode
2024-10-24 06:15:04 +02:00
parent b66b53ceaa
commit c9f216c550
1 changed files with 4 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/app/components/generator/McdocRenderer.tsx
View File

@@ -33,7 +33,6 @@ export function McdocRoot({ node, makeEdit, ctx } : Props) {
return <>
<div class="node-header">
<Errors node={node} ctx={ctx} />
<Docs hover={node?.hover} />
<Key label={locale('root')} />
<Head type={type} node={node} makeEdit={makeEdit} ctx={ctx} />
</div>
@@ -479,7 +478,7 @@ function StructBody({ type: outerType, node, makeEdit, ctx }: StructBodyProps) {
return <div class="node">
<div class="node-header">
<Errors node={childValue} ctx={ctx} />
<Docs hover={childValue?.hover ?? child?.key?.hover ?? child?.hover} />
<Docs desc={field.desc} />
<Key label={key} />
<Head type={fieldType} node={childValue} optional={field.optional} makeEdit={makeFieldEdit} ctx={ctx} />
</div>
@@ -528,7 +527,6 @@ function ListBody({ type: outerType, node, makeEdit, ctx }: ListBodyProps) {
return <div class="node">
<div class="node-header">
<Errors node={child} ctx={ctx} />
<Docs hover={child?.hover ?? item.hover} />
<button class="remove tooltipped tip-se" aria-label={locale('remove')} onClick={() => onRemoveItem(index)}>
{Octicon.trashcan}
</button>
@@ -578,7 +576,6 @@ function TupleBody({ type, node, makeEdit, ctx }: TupleBodyProps) {
return <div class="node">
<div class="node-header">
<Errors node={child} ctx={ctx} />
<Docs hover={child?.hover ?? itemNode.hover} />
<Key label="entry" />
<Head type={itemType} node={child} makeEdit={makeItemEdit} ctx={ctx} />
</div>
@@ -620,15 +617,10 @@ function ErrorIndicator({ error }: ErrorIndicatorProps) {
}
interface DocsProps {
hover: string | undefined
desc: string | undefined
}
function Docs({ hover }: DocsProps) {
if (hover === undefined) {
return <></>
}
const descStart = hover.indexOf('```', hover.indexOf('```') + 3) + 4
const desc = hover.substring(descStart).trim().replaceAll('`', '')
if (desc.length === 0) {
function Docs({ desc }: DocsProps) {
if (!desc || desc.length === 0) {
return <></>
}