From 49cf69b4f42ecf0918de88e48eeaa7efa673c344 Mon Sep 17 00:00:00 2001 From: Loren Norman Date: Fri, 25 Jul 2025 14:05:30 -0400 Subject: [PATCH] remove empty and unimplemented sections --- src/docs/render_block.js | 44 ++++++++++++++++++++++++++------- src/docs/render_block_fields.js | 2 +- src/docs/render_block_inputs.js | 4 +-- 3 files changed, 37 insertions(+), 13 deletions(-) diff --git a/src/docs/render_block.js b/src/docs/render_block.js index d9d3cb1..dccbd98 100644 --- a/src/docs/render_block.js +++ b/src/docs/render_block.js @@ -1,4 +1,4 @@ -import { capitalize, trim } from 'lodash-es' +import { trim } from 'lodash-es' import renderFields from './render_block_fields.js' import renderInputs from './render_block_inputs.js' @@ -21,12 +21,42 @@ This Block requires an IO+ subscription to use. [Learn more about IO+](https://i renderIOPlusAlert = ({ ioPlus }) => ioPlus ? IO_PLUS_ALERT : "", + renderFieldsSection = definition => { + const fieldsMarkdown = renderFields(definition) + + return fieldsMarkdown + ? `## Fields\n\n${ fieldsMarkdown }` + : "" + }, + + renderInputsSection = definition => { + const inputsMarkdown = renderInputs(definition) + + return inputsMarkdown + ? `## Inputs\n\n${ inputsMarkdown }` + : "" + }, + renderOutput = definition => { - return capitalize(definition.connections?.output || "Unspecified") + return '' + + // TODO: re-enable when we have something meanginful to show the user + // const defaultedOutput = capitalize(definition.connections?.output || "Unspecified") + + // return ` + // ## Output + // ${ defaultedOutput } + // ` }, renderExamples = definition => { - return "Coming soon..." + return "" + + // TODO: re-enable conditionally when we have examples + // return ` + // ## Examples + // Coming soon... + // ` } export default definition => @@ -44,15 +74,11 @@ ${ renderDescription(definition) } ${ renderIOPlusAlert(definition) } -## Fields -${ renderFields(definition) } +${ renderFieldsSection(definition) } -## Inputs -${ renderInputs(definition) } +${ renderInputsSection(definition) } -## Output ${ renderOutput(definition) } -## Examples ${ renderExamples(definition) } ` diff --git a/src/docs/render_block_fields.js b/src/docs/render_block_fields.js index aa92472..d112cdf 100644 --- a/src/docs/render_block_fields.js +++ b/src/docs/render_block_fields.js @@ -14,7 +14,7 @@ const return newField })) - if(!fields.length) { return "This block has no form fields." } + if(!fields.length) { return } return fields.map(renderField).join("\n\n") }, diff --git a/src/docs/render_block_inputs.js b/src/docs/render_block_inputs.js index 1127201..bd14240 100644 --- a/src/docs/render_block_inputs.js +++ b/src/docs/render_block_inputs.js @@ -9,9 +9,7 @@ const return renderOverridenInputs(definition) } - if(!keys(definition.inputs).length) { - return "This block has no inputs" - } + if(!keys(definition.inputs).length) { return } return renderEachInput(definition) },