Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
hamelsmu opened this issue Jun 21, 2022 · 3 comments
Open

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

hamelsmu opened this issue Jun 21, 2022 · 3 comments
Assignees
Labels

Comments

@hamelsmu
Copy link
Contributor

hamelsmu commented Jun 21, 2022

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

@hamelsmu
Copy link
Contributor Author

Ok whatever was fixed caused a new problem

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>

@hamelsmu hamelsmu reopened this Jun 21, 2022
@obgibson
Copy link
Collaborator

Screen Shot 2022-06-22 at 6 14 35 AM

That MDX worksforme

@hamelsmu
Copy link
Contributor Author

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 🙇🏽

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants