Allow customizing the "self" reference

[johnpmcconnell]

THANK YOU! This is pretty much exactly what I was looking for.

Currently, this plug in generates "signatures" (for lack of a better term) that use the name self to reference the object. It would improve the output if we could customize this name somehow. A couple of ways of doing it that I can think of:

• Define a directive or parameter that's read from the docstring.
• Pick up on names other than self from the code.

I'd prefer to explicitly declare the name in the docstring, personally. self is a very strong naming convention that I wouldn't want to violate.

[cspotcode]

Is this going to happen?

I would like a simple config I can put in conf.py, something like:

prettyspecialmethods_self_format = "pascal_to_snake" # current behavior is "self"

When set, the class's name FooBar is converted to foo_bar e.g. len(foo_bar) or len(scheduler_list)for a hypotheticalclass SchedulerList`

If that is not sufficient, then there can also be an event emitted which is allowed to return the string to use.

app.connect("prettyspecialmethods-self-format", my_function)

[cspotcode]

An example of this in python's official docs:

https://docs.python.org/3/library/stdtypes.html#dict

Linked from here: #6 (comment)

Python's official docs avoid using self. They use d to refer to a dictionary, as in len(d), then describe it like this: "Return the number of items in the dictionary d."