Bug report #19012

[PyQGIS Doc] Make all syntaxes obvious when a method has more than one syntax

Added by Harrissou Santanna about 2 years ago. Updated almost 2 years ago.

Status:Closed
Priority:Normal
Assignee:Denis Rouzaud
Category:Documentation and Help
Affected QGIS version:3.1(master) Regression?:No
Operating System: Easy fix?:No
Pull Request or Patch supplied:No Resolution:up/downstream
Crashes QGIS or corrupts data:No Copied to github as #:26843

Description

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.).

History

#1 Updated by Nyall Dawson about 2 years ago

  • Assignee changed from Yves Jacolin to Denis Rouzaud

#3 Updated by Denis Rouzaud almost 2 years ago

  • Resolution set to up/downstream
  • Status changed from Open to Closed

Also available in: Atom PDF