Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

overloaded methods #18

Open
3nids opened this issue May 24, 2018 · 2 comments
Open

overloaded methods #18

3nids opened this issue May 24, 2018 · 2 comments

Comments

@3nids
Copy link
Member

3nids commented May 24, 2018

Go to https://qgis.org/pyqgis/master/core/Layout/QgsLayoutExporter.html#qgis.core.QgsLayoutExporter.exportToPdf
The exportToPdf has more than one way to call it but only the one in the grayed area (next to the name) is obvious, and when looking for a function you may miss the other alternative. This is also true for exportToImage, exportToSVG, print... (at least in this class).
Moreover, the paragraph showing the second alternative does not look sexy to read and you want to skip it (I unfortunately did it (!) for hours until I find in the github repo what I was looking for, which is not the way we want people to proceed.).

@3nids
Copy link
Member Author

3nids commented Oct 15, 2019

sphinx-doc/sphinx#2106

I don't see any solution for this at the moment except reimplementing autodoc

@kannes
Copy link

kannes commented May 29, 2022

sphinx-doc/sphinx#2106

This issue has been closed as implemented and it seems that overloaded functions can now be handled by Sphinx. :))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants