You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<DocSectiontype="property"name="input"module="metaflow.flowspec"show_import="False"heading_level="4"link="https://github.com/Netflix/metaflow/tree/master/">
<Descriptionsummary="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
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.
In the below MDX, the description is completely missing still
<DocSection type="property" name="input" module="metaflow.flowspec" show_import="False" heading_level="4" link="https://github.com/Netflix/metaflow/tree/master/">
<Description summary="Value passed to the task in a foreach step\n\nIn a foreach step, multiple instances of this step (tasks) will be executed,\none for each element in the foreach.\nThis property returns the element passed to the current task. If this is not\na foreach step, this returns None.\n\nSee Also\n--------\nforeach_stack: A detailed example is given in the documentation of this function\n\nReturns\n-------\nobject\n Input passed to the task (can be any object)" />
</DocSection>
ok let me try a few more things @obgibson do you mind sharing the mdx for that, note that the mdx I shared is veryminimal there is only the Description child element and that is it.
If you prefer I can get some time to troubleshoot live. Thanks for your help 🙇🏽
The following Doesn't render a the description
Results in
It appears that if I add a
SigArg
component the description rendersBut this is not desired behavior, since the presence of SigArg also adds parenthesis to the rendered object name.
cc: @obgibson
The text was updated successfully, but these errors were encountered: