Commitd8a91ba

authored and

committed

Proof of concept for adding kwdoc content to properties using a decorator

1 parent61ed3f4 commitd8a91baCopy full SHA for d8a91ba

File tree

+29

-0

lines changed

+29

-0

lines changed

Lines changed: 25 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,31 @@`
`3`	`3`	`from .import_api`
`4`	`4`
`5`	`5`
	`6`	`+defkwarg_doc(text):`
	`7`	`+"""`
	`8`	`+ Decorator for defining the documentation used when artist properties are`
	`9`	`+ passed through as keyword arguments.`
	`10`	`+`
	`11`	+ See e.g. the `**kwargs` section in `.Axes.text`.
	`12`	`+`
	`13`	+ The given text is stored in a privat variable ``_kwarg_doc`` on the method.
	`14`	`+ It is used for generating the kwdoc list for artists, which we`
	`15`	`+ auto-generate through docstring interpolation, e.g. via`
	`16`	+ ``%(Line2D:kwdoc)s``.
	`17`	`+`
	`18`	`+ The text should contain the supported types as well as the default value`
	`19`	`+ if applicable, e.g.:`
	`20`	`+`
	`21`	+ @_docstring.kwarg_doc("bool, default: :rc:`text.usetex`")
	`22`	`+ def set_usetex(self, usetex):`
	`23`	`+`
	`24`	`+ """`
	`25`	`+defdecorator(func):`
	`26`	`+func._kwarg_doc=text`
	`27`	`+returnfunc`
	`28`	`+returndecorator`
	`29`	`+`
	`30`	`+`
`6`	`31`	`classSubstitution:`
`7`	`32`	`"""`
`8`	`33`	`A decorator that performs %-substitution on an object's docstring.`

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1479,6 +1479,9 @@ def get_valid_values(self, attr):`
`1479`	`1479`	`raiseAttributeError(f'{self.o} has no function{name}')`
`1480`	`1480`	`func=getattr(self.o,name)`
`1481`	`1481`
	`1482`	`+ifhasattr(func,'_kwarg_doc'):`
	`1483`	`+returnfunc._kwarg_doc`
	`1484`	`+`
`1482`	`1485`	`docstring=inspect.getdoc(func)`
`1483`	`1486`	`ifdocstringisNone:`
`1484`	`1487`	`return'unknown'`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1282,6 +1282,7 @@ def set_fontproperties(self, fp):`
`1282`	`1282`	`self._fontproperties=FontProperties._from_any(fp).copy()`
`1283`	`1283`	`self.stale=True`
`1284`	`1284`
	`1285`	+@_docstring.kwarg_doc("bool, default: :rc:`text.usetex`")
`1285`	`1286`	`defset_usetex(self,usetex):`
`1286`	`1287`	`"""`
`1287`	`1288`	`Parameters`

Comments

(0)