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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

function docs are rendering extraneous information #194

Closed
hamelsmu opened this issue Jun 24, 2023 · 3 comments
Closed

function docs are rendering extraneous information #194

hamelsmu opened this issue Jun 24, 2023 · 3 comments

Comments

@hamelsmu
Copy link
Collaborator

hamelsmu commented Jun 24, 2023

See this repo for a clean repro

Seems like lots of code is spilling into the rendered description? 馃憞馃徑

image

If you run quartodoc build followed by quarto preview you can see the issue

I can't see any issue off hand why this should happen based on the source code of that particular function that it is throwing up on https://github.com/fastai/fastcore/blob/master/fastcore/basics.py#L147-L151

cc: @machow

@hamelsmu hamelsmu changed the title fastcore doesn't render properly function docs are rendering information from other places/other code Jun 24, 2023
@hamelsmu hamelsmu changed the title function docs are rendering information from other places/other code function docs are rendering extraneous information Jun 24, 2023
@machow
Copy link
Owner

machow commented Jun 25, 2023

It looks like the docstring for exec_local has a typo in it. It's missing the closing backtick for `var_name

@hamelsmu
Copy link
Collaborator Author

Ok fixing the backtick(fastai/fastcore#530) fixed it, but perhaps we should make quartodoc more resilient towards this

@hamelsmu
Copy link
Collaborator Author

This is fixed

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

No branches or pull requests

2 participants