You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Sphinx does not use an unordered list <ul> if there is only a single element:
Compare that to:
We think it would be more readable if we always used a bullet list, even when there is only one element:
This is the path forward for adding indentation, #736.
--
This change should happen in the API conversion script, rather than the web app. That is, the change should happen in the children of the <Function> component, rather than the component itself making this transformation. We would update processHtml.ts to convert single values into a <ul> with one <li>.
Sphinx does not use an unordered list
<ul>
if there is only a single element:Compare that to:
We think it would be more readable if we always used a bullet list, even when there is only one element:
This is the path forward for adding indentation, #736.
--
This change should happen in the API conversion script, rather than the web app. That is, the change should happen in the children of the
<Function>
component, rather than the component itself making this transformation. We would updateprocessHtml.ts
to convert single values into a<ul>
with one<li>
.This should be done for
Params
,Raises
, probablyYields
, and probably more of https://sphinxcontrib-napoleon.readthedocs.io/en/latest/#docstring-sections. But it should not be added to everything. For example,return type
should not have indentation since it never has >1 element.The text was updated successfully, but these errors were encountered: