Skip to content

[Api Docs 2.0] Docs Do not show up without a SigArgs section #57

Open
@hamelsmu

Description

@hamelsmu

The following Doesn't render a the description

<DocSection type="property" name="input" module="metaflow.flowspec" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/">
<Description summary="A Flow represents all existing flows with a certain name, in other words,\nclasses derived from 'FlowSpec'" extended_summary="As such, it contains all Runs (executions of a flow) related to this flow." />
</DocSection>

Results in

image

It appears that if I add a SigArg component the description renders

<SigArgSection>
</SigArgSection>

But this is not desired behavior, since the presence of SigArg also adds parenthesis to the rendered object name.

cc: @obgibson

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions