search

pygobject / pgi-docgen

API Documentation Generator for PyGObject
https://lazka.github.io/pgi-docs/
GNU Lesser General Public License v2.1
129 stars 36 forks source link

Rewrite instance param references to "self" #116

Closed lazka closed 6 years ago

lazka commented 8 years ago

e.g. https://lazka.github.io/pgi-docs/#Gdk-3.0/classes/Window.html#Gdk.Window.begin_paint_region

Instead of "window" it should say "self" everywhere. Probably extract the "instance-parameter" when parsing the gir and use that in the doc parser.

lazka commented 8 years ago

"self" is confusing in many places. I think using the Python class name would be better, e.g.

Adds the device events in the bitfield events to the event mask for Gtk.Widget

instead of

Adds the device events in the bitfield events to the event mask for self

lazka commented 6 years ago

"self" is confusing in many places. I think using the Python class name would be better, e.g.

It's not a clear win, let's leave it as is.