plone / plone.api

The Plone API
https://6.docs.plone.org/plone.api
Other
86 stars 53 forks source link

Enhance API docs of portal.translate to show that the domain is optio… #510

Closed thet closed 1 year ago

thet commented 1 year ago

…nal in some cases.

If anyone can point me to some documentation on the api doc syntax, I'd be happy. Didn't found anything than docs on how to use sphinx autodoc on an API level and so forth.

mister-roboto commented 1 year ago

@thet thanks for creating this Pull Request and helping to improve Plone!

TL;DR: Finish pushing changes, pass all other checks, then paste a comment:

@jenkins-plone-org please run jobs

To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically.

Happy hacking!

thet commented 1 year ago

@stevepiercy tnx for the review and sorry for my late reply. I've updated this PR with your suggestions.

thet commented 1 year ago

Thank you! I applied your suggestions. I'm merging.