Put arguments to new lines for long function signatures #388
-
|
With long function signatures you get something like:
It's quite ugly to look at, better would be: class pastry.auth.token_provider.OAuth2TokenProvider(
url: str,
client_id: Optional[str] = None,
client_secret: Optional[str] = None,
...and so on...
)There's a ticket also for Sphinx about the same thing at sphinx-doc/sphinx#1514 but this is perhaps a representation issue, rather, and should be discussed per theme. Hacking the CSS I could probably make each parameter show on a new line, but that would then apply also for functions with only 1-2 parameters, too. Would detecting long signatures be difficult? |
Beta Was this translation helpful? Give feedback.
Replies: 3 comments 7 replies
-
|
This isn’t feasible in CSS or the theme side without invasive hacks. It has to happen on Sphinx’s end. |
Beta Was this translation helpful? Give feedback.
-
|
Impressive response time 🤗 I think even then "detecting a long line" might be problematic as styling then makes the lines various lengths. Alright. |
Beta Was this translation helpful? Give feedback.
-
|
sphinx-doc/sphinx#1514 (comment) seems to imply the Sphinx side is done @pradyunsg? |
Beta Was this translation helpful? Give feedback.
-
|
I could get it somewhat working with the custom CSS shown in this comment
to
|
Beta Was this translation helpful? Give feedback.
-
|
@pradyunsg - I tagged you on sphinx-doc/sphinx#1514 (comment), which I think is the closest I've found to a relevant open issue for Sphinx itself. I guess we really want this to be intelligent, no point in putting short argument definitions on multiple lines, but really want to see long signatures split. Doing whatever is done in the source might be a good option... Anyway, I have a particularly ugly example now, so keen to help where I can or nudge things along where I can't ;-) |
Beta Was this translation helpful? Give feedback.
-
|
FWIW, @cjw296 I just used that "ugly" example, to advocate for the behaviours in a PR about this. ;) |
Beta Was this translation helpful? Give feedback.
-
|
sphinx-doc/sphinx#11011 seems like the way forward here. Once that is implemented, I'd be happy to make sure that Furo handles that output gracefully. :) |
Beta Was this translation helpful? Give feedback.
-
|
@pradyunsg - cool, should we open an issue in this repo to track? Lots of work seems to be happening on that PR so 🤞 |
Beta Was this translation helpful? Give feedback.
-
|
No. It should "just work" last I checked, and if it doesn't, file a discussion as a potential issue for that. |
Beta Was this translation helpful? Give feedback.
-
|
🤞 |
Beta Was this translation helpful? Give feedback.
sphinx-doc/sphinx#11011 seems like the way forward here. Once that is implemented, I'd be happy to make sure that Furo handles that output gracefully. :)