gpt4 book ai didi

python - 如何在长函数签名中换行并在 Sphinx autodoc 中对其进行漂亮的格式化

转载 作者:行者123 更新时间:2023-12-04 13:57:03 24 4
gpt4 key购买 nike

我有一个带有类型提示的长签名函数,例如

def set_parameters(
tokenizer: Union[None, "Tokenizer", str] = None,
vocab: Optional["Vocab"] = None,
vocab_from: Optional[Dict[str, str]] = None,
max_sent_length: Optional[int] = None,
max_turn_length: Optional[int] = None,
convert_to_lower_letter: Optional[bool] = None,
weak=False) -> "FieldContext":

我使用 Sphinx autodoc 来生成文档字符串。
.. autofunction:: set_parameters

然后,Sphinx 将忽略换行符并在一行中描述函数。
set_parameters(tokenizer: Union[None, Tokenizer, str] = None, vocab: Optional[Vocab] = None, vocab_from: Optional[Dict[str, str]] = None, max_sent_length: Optional[int] = None,    max_turn_length: Optional[int] = None, convert_to_lower_letter: Optional[bool] = None, weak=False) -> FieldContext:

它非常丑陋且难以阅读。我想要的是它要么跟随我的代码中的换行符,要么自动做一些换行符。有什么办法可以实现吗?

最佳答案

一个快速而肮脏的选择是使用 CSS:

dl.class > dt > em:before {
content: ' ';
display: block;
}

它并不完美或漂亮,但它至少将参数放入一个更易于视觉扫描的列表中。

关于python - 如何在长函数签名中换行并在 Sphinx autodoc 中对其进行漂亮的格式化,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/60146577/

24 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com