huggingface / huggingface/doc-builder

Malformed Deprecated rendering when parameter is under an Args subsection

Open
#627 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

I discovered that there is a bug in the rendering of the Deprecated directive in the Args section when the parameter is under an Args subsection.

For example:
```python
Args:

> Deprecated parameters

rloo_k:

This parameter is deprecated and will be removed in version 0.25.0. Use `num_generations` instead.


```
is not properly rendered:
Screenshot 2025-09-15 at 8 50 52 AM

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.