api reference tweaks #651
api reference tweaks #651
Conversation
There was a problem hiding this comment.
I have some minor comments, but I really like the result, that's what I was hoping for : )
I wouldn't deal now with things like duplicated handbook url in the index, there's a task for this: https://github.com/orgs/golemfactory/projects/14
| @@ -2,6 +2,7 @@ | |||
| import itertools | |||
| from typing import Any, Awaitable, Callable, Dict, Iterator, Optional, List, TYPE_CHECKING | |||
|
|
|||
| import yapapi | |||
There was a problem hiding this comment.
Duh, this is ugly.
I more-or-less understand why we have this, but I think the generated documentation is exactly the same before this change, so this only silences warnings. I don't think it's worth it?
Or maybe if Script had :params: section this would be different?
There was a problem hiding this comment.
no, it's not exactly the same -> without it, the type hints don't link and there's an ugly ForwardRef link instead...
There was a problem hiding this comment.
anyway, we definitely do have a differing definition of "ugly" ... to me, it's "inelegant" at most ...
There was a problem hiding this comment.
- I tried this once and compared result files with
diffand got no difference. I'll try this again - OK, inelegant is fine (although I'd say everything related to python annotations deserves this name). Either way, I'd be glad to get rid of it if we can : )
Co-authored-by: johny-b <[email protected]>
…apapi into blue/api-reference-tweaks
No description provided.