huggingface / huggingface/doc-builder

In-parameter docstrings don't support code samples

Open
#171 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
144
Forks
59
Avg merge
2d 5h
Merged PRs (30d)
13

Description

If designing a docstring of a parameter with an in-line code sample, it will not be rendered correctly, e.g.:

```
Args:
argument (`str`):
A cool argument

```python
import os
os.listdir()
```
argument_2 (`bool`):
A really cool argument
```

In that case, the `argument_2` will not be rendered correctly. Perfectly fine if it's out of scope for the repo, just making sure it's not a bug.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.