Lines Matching refs:be
8 The documentation should be consistent with the corresponding C API
11 performance factors) should not be copied.
15 Docstrings are to be written in `numpydoc:format` format.
17 The first line of a class, function or method docstring must be a short
19 "Return" is to be preferred over "Get" in this sentence. A blank line must
23 collective, then this information must be repeated on the next line of the
30 should be referred to from here.
40 allowed by numpydoc may be included if they are useful.
45 This is required for methods unless there are no parameters, or it will be
49 their types must be explicitly documented within this section.
51 For methods, types should only be specified in this section if for some reason
52 the types provided by typing prove to be inadequate. If no type is being
60 This should only be specified if the return value is not obvious from the
63 If a "Returns" section is required, the type of the returned items *must* be
78 If there is a corresponding C API documentation page, this must be linked from
81 End docstring with an empty line - "closing three quotation marks must be on a
90 type (e.g. ``Vec x``). These will be automatically generated. This will also
100 enum the ``| str`` can be omitted. Full signature example::