IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-08-07 11:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8614 from tk0miya/deprecate_AttributeDocumenter_isinstanceattribute

Browse Source 
refactor: Deprecate AttributeDocumenter.isinstanceattribute()
This commit is contained in:
Takeshi KOMIYA
2020-12-30 19:47:17 +09:00
committed by GitHub
parent c99412695d c0f923ee6c
commit 21698c1446
3 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGES
+1
View File
@@ -10,6 +10,7 @@ Incompatible changes
Deprecated
----------
* ``sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()``
* ``sphinx.ext.autodoc.importer.get_module_members()``
Features added
doc/extdev/deprecated.rst
+5
View File
@@ -26,6 +26,11 @@ The following is a list of deprecated interfaces.
- (will be) Removed
- Alternatives
* - ``sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()``
- 3.5
- 5.0
- N/A
* - ``sphinx.ext.autodoc.importer.get_module_members()``
- 3.5
- 5.0
sphinx/ext/autodoc/__init__.py
+2
View File
@@ -2362,6 +2362,8 @@ class AttributeDocumenter(GenericAliasMixin, NewTypeMixin, SlotsMixin, # type:
def isinstanceattribute(self) -> bool:
"""Check the subject is an instance attribute."""
warnings.warn('AttributeDocumenter.isinstanceattribute() is deprecated.',
RemovedInSphinx50Warning)
# uninitialized instance variable (PEP-526)
with mock(self.config.autodoc_mock_imports):
try: