apify / apify-client-python

Apify API client for Python
https://docs.apify.com/api/client/python/
Apache License 2.0
46 stars 11 forks source link

feat(docs): Add indicator for keyword-only arguments, add link to method sources #134

Closed fnesveda closed 1 year ago

fnesveda commented 1 year ago

The docs were not showing which method arguments are positional and which are keyword-only. This adjusts the docs generation so that there is a * in the argument list before the first keyword-only argument, and also that there is a keyword-only tag next to those arguments.

And while I was messing with it I adjusted it so that the methods also include a link to their source code.

This might be pretty hard to review code-wise, because it's mostly just package patches, so I think just check if you think the result is OK, or if it should be adjusted. For the future, I vote to fork docusaurus-plugin-typedoc-api and use the fork here, so that the changes we make to it are more reviewable.

Once approved, I will do it in the SDK as well.

Screenshot 2023-07-25 at 19 37 15
fnesveda commented 1 year ago

It does, I wanted to add it in the next iteration, but maybe I'll do it now since I have it open

fnesveda commented 1 year ago

@barjin It works! I also fixed the empty "Return" text at the bottom of the constructor:

Screenshot 2023-07-25 at 20 35 26