PyDoc: correct use of back ticks for literal text

This commit is contained in:
Campbell Barton
2025-08-22 15:10:29 +10:00
parent 78c9d16919
commit e964f078b5
23 changed files with 100 additions and 95 deletions

View File

@@ -2,12 +2,12 @@
Basic FileHandler for importing a single file
---------------------------------------------
A file handler allows custom 'drag-and-drop' behavior to be associated with a given ``Operator``
A file handler allows custom drag-and-drop behavior to be associated with a given ``Operator``
(:class:`FileHandler.bl_import_operator`) and set of file extensions
(:class:`FileHandler.bl_file_extensions`). Control over which area of the UI accepts the
`drag-in-drop` action is specified using the :class:`FileHandler.poll_drop` method.
drag-in-drop action is specified using the :class:`FileHandler.poll_drop` method.
Similar to operators that use a file select window, operators participating in 'drag-and-drop', and
Similar to operators that use a file select window, operators participating in drag-and-drop, and
only accepting a single file, must define the following property:
.. code-block:: python

View File

@@ -2,7 +2,7 @@
FileHandler for Importing multiple files and exposing Operator options
----------------------------------------------------------------------
Operators which support being executed with multiple files from 'drag-and-drop' require the
Operators which support being executed with multiple files from drag-and-drop require the
following properties be defined:
.. code-block:: python
@@ -11,7 +11,7 @@ following properties be defined:
files: CollectionProperty(type=OperatorFileListElement, options={'SKIP_SAVE', 'HIDDEN'})
These ``directory`` and ``files`` properties will be set with the necessary data from the
`drag-and-drop` operation.
drag-and-drop operation.
Additionally, if the operator provides operator properties that need to be accessible to the user,
the :class:`ImportHelper.invoke_popup` method can be used to show a dialog leveraging the standard

View File

@@ -1741,7 +1741,7 @@ def pyrna2sphinx(basepath):
if not descr:
descr = prop.name
# In rare cases `descr` may be empty.
fw(" `{:s}`, {:s}\n\n".format(
fw(" ``{:s}``, {:s}\n\n".format(
prop.identifier,
", ".join((val for val in (descr, type_descr) if val))
))