Commit21a6820

committed

Remove undoc-members and add documentation for __init__

The public API should all be documented. Anything that isn't documented with adocstring or starts with a _ isn't part of the public API. Given that, weshouldn't be autodoc'ing undocumented members.We do want to document __init__ since that's how the classes get built. Sowe explicitly add that to autodoc.I think this is a good base to build on. If it isn't, we can adjust thingsand maybe explicitly specify what should and shouldn't be documented.

1 parent461bda3 commit21a6820Copy full SHA for 21a6820

File tree

5 files changed

+24

-29

lines changed

5 files changed

+24

-29

lines changed

`‎doc/html5lib.filters.rst`

Lines changed: 7 additions & 8 deletions

Original file line number	Diff line number	Diff line change
`@@ -6,54 +6,53 @@ filters Package`
`6`	`6`
`7`	`7`	`..automodule::html5lib.filters.base`
`8`	`8`	`:members:`
`9`		`-:undoc-members:`
`10`	`9`	`:show-inheritance:`
	`10`	`+:special-members: __init__`
`11`	`11`
`12`	`12`	:mod:`alphabeticalattributes` Module
`13`	`13`	`------------------------------------`
`14`	`14`
`15`	`15`	`..automodule::html5lib.filters.alphabeticalattributes`
`16`	`16`	`:members:`
`17`		`-:undoc-members:`
`18`	`17`	`:show-inheritance:`
	`18`	`+:special-members: __init__`
`19`	`19`
`20`	`20`	:mod:`inject_meta_charset` Module
`21`	`21`	`---------------------------------`
`22`	`22`
`23`	`23`	`..automodule::html5lib.filters.inject_meta_charset`
`24`	`24`	`:members:`
`25`		`-:undoc-members:`
`26`	`25`	`:show-inheritance:`
	`26`	`+:special-members: __init__`
`27`	`27`
`28`	`28`	:mod:`lint` Module
`29`	`29`	`------------------`
`30`	`30`
`31`	`31`	`..automodule::html5lib.filters.lint`
`32`	`32`	`:members:`
`33`		`-:undoc-members:`
`34`	`33`	`:show-inheritance:`
	`34`	`+:special-members: __init__`
`35`	`35`
`36`	`36`	:mod:`optionaltags` Module
`37`	`37`	`--------------------------`
`38`	`38`
`39`	`39`	`..automodule::html5lib.filters.optionaltags`
`40`	`40`	`:members:`
`41`		`-:undoc-members:`
`42`	`41`	`:show-inheritance:`
	`42`	`+:special-members: __init__`
`43`	`43`
`44`	`44`	:mod:`sanitizer` Module
`45`	`45`	`-----------------------`
`46`	`46`
`47`	`47`	`..automodule::html5lib.filters.sanitizer`
`48`	`48`	`:members:`
`49`		`-:undoc-members:`
`50`	`49`	`:show-inheritance:`
	`50`	`+:special-members: __init__`
`51`	`51`
`52`	`52`	:mod:`whitespace` Module
`53`	`53`	`------------------------`
`54`	`54`
`55`	`55`	`..automodule::html5lib.filters.whitespace`
`56`	`56`	`:members:`
`57`		`-:undoc-members:`
`58`	`57`	`:show-inheritance:`
`59`		`-`
	`58`	`+:special-members: __init__`

`‎doc/html5lib.rst`

Lines changed: 2 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -9,24 +9,23 @@ html5lib Package`
`9`	`9`
`10`	`10`	`..automodule::html5lib.constants`
`11`	`11`	`:members:`
`12`		`-:undoc-members:`
`13`	`12`	`:show-inheritance:`
`14`	`13`
`15`	`14`	:mod:`html5parser` Module
`16`	`15`	`-------------------------`
`17`	`16`
`18`	`17`	`..automodule::html5lib.html5parser`
`19`	`18`	`:members:`
`20`		`-:undoc-members:`
`21`	`19`	`:show-inheritance:`
	`20`	`+:special-members: __init__`
`22`	`21`
`23`	`22`	:mod:`serializer` Module
`24`	`23`	`------------------------`
`25`	`24`
`26`	`25`	`..automodule::html5lib.serializer`
`27`	`26`	`:members:`
`28`		`-:undoc-members:`
`29`	`27`	`:show-inheritance:`
	`28`	`+:special-members: __init__`
`30`	`29`
`31`	`30`	`Subpackages`
`32`	`31`	`-----------`
`@@ -37,4 +36,3 @@ Subpackages`
`37`	`36`	`html5lib.treebuilders`
`38`	`37`	`html5lib.treewalkers`
`39`	`38`	`html5lib.treeadapters`
`40`		`-`

`‎doc/html5lib.treeadapters.rst`

Lines changed: 4 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,20 +1,20 @@`
`1`		`-treebuilders Package`
	`1`	`+treeadapters Package`
`2`	`2`	`====================`
`3`	`3`
`4`	`4`	:mod:`~html5lib.treeadapters` Package
`5`	`5`	`-------------------------------------`
`6`	`6`
`7`	`7`	`..automodule::html5lib.treeadapters`
`8`	`8`	`:members:`
`9`		`-:undoc-members:`
`10`	`9`	`:show-inheritance:`
	`10`	`+:special-members: __init__`
`11`	`11`
`12`	`12`	`..automodule::html5lib.treeadapters.genshi`
`13`	`13`	`:members:`
`14`		`-:undoc-members:`
`15`	`14`	`:show-inheritance:`
	`15`	`+:special-members: __init__`
`16`	`16`
`17`	`17`	`..automodule::html5lib.treeadapters.sax`
`18`	`18`	`:members:`
`19`		`-:undoc-members:`
`20`	`19`	`:show-inheritance:`
	`20`	`+:special-members: __init__`

`‎doc/html5lib.treebuilders.rst`

Lines changed: 5 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -6,38 +6,37 @@ treebuilders Package`
`6`	`6`
`7`	`7`	`..automodule::html5lib.treebuilders`
`8`	`8`	`:members:`
`9`		`-:undoc-members:`
`10`	`9`	`:show-inheritance:`
	`10`	`+:special-members: __init__`
`11`	`11`
`12`	`12`	:mod:`base` Module
`13`	`13`	`-------------------`
`14`	`14`
`15`	`15`	`..automodule::html5lib.treebuilders.base`
`16`	`16`	`:members:`
`17`		`-:undoc-members:`
`18`	`17`	`:show-inheritance:`
	`18`	`+:special-members: __init__`
`19`	`19`
`20`	`20`	:mod:`dom` Module
`21`	`21`	`-----------------`
`22`	`22`
`23`	`23`	`..automodule::html5lib.treebuilders.dom`
`24`	`24`	`:members:`
`25`		`-:undoc-members:`
`26`	`25`	`:show-inheritance:`
	`26`	`+:special-members: __init__`
`27`	`27`
`28`	`28`	:mod:`etree` Module
`29`	`29`	`-------------------`
`30`	`30`
`31`	`31`	`..automodule::html5lib.treebuilders.etree`
`32`	`32`	`:members:`
`33`		`-:undoc-members:`
`34`	`33`	`:show-inheritance:`
	`34`	`+:special-members: __init__`
`35`	`35`
`36`	`36`	:mod:`etree_lxml` Module
`37`	`37`	`------------------------`
`38`	`38`
`39`	`39`	`..automodule::html5lib.treebuilders.etree_lxml`
`40`	`40`	`:members:`
`41`		`-:undoc-members:`
`42`	`41`	`:show-inheritance:`
`43`		`-`
	`42`	`+:special-members: __init__`

`‎doc/html5lib.treewalkers.rst`

Lines changed: 6 additions & 7 deletions

Original file line number	Diff line number	Diff line change
`@@ -6,46 +6,45 @@ treewalkers Package`
`6`	`6`
`7`	`7`	`..automodule::html5lib.treewalkers`
`8`	`8`	`:members:`
`9`		`-:undoc-members:`
`10`	`9`	`:show-inheritance:`
	`10`	`+:special-members: __init__`
`11`	`11`
`12`	`12`	:mod:`base` Module
`13`	`13`	`------------------`
`14`	`14`
`15`	`15`	`..automodule::html5lib.treewalkers.base`
`16`	`16`	`:members:`
`17`		`-:undoc-members:`
`18`	`17`	`:show-inheritance:`
	`18`	`+:special-members: __init__`
`19`	`19`
`20`	`20`	:mod:`dom` Module
`21`	`21`	`-----------------`
`22`	`22`
`23`	`23`	`..automodule::html5lib.treewalkers.dom`
`24`	`24`	`:members:`
`25`		`-:undoc-members:`
`26`	`25`	`:show-inheritance:`
	`26`	`+:special-members: __init__`
`27`	`27`
`28`	`28`	:mod:`etree` Module
`29`	`29`	`-------------------`
`30`	`30`
`31`	`31`	`..automodule::html5lib.treewalkers.etree`
`32`	`32`	`:members:`
`33`		`-:undoc-members:`
`34`	`33`	`:show-inheritance:`
	`34`	`+:special-members: __init__`
`35`	`35`
`36`	`36`	:mod:`etree_lxml` Module
`37`	`37`	`------------------------`
`38`	`38`
`39`	`39`	`..automodule::html5lib.treewalkers.etree_lxml`
`40`	`40`	`:members:`
`41`		`-:undoc-members:`
`42`	`41`	`:show-inheritance:`
`43`		`-`
	`42`	`+:special-members: __init__`
`44`	`43`
`45`	`44`	:mod:`genshi` Module
`46`	`45`	`--------------------`
`47`	`46`
`48`	`47`	`..automodule::html5lib.treewalkers.genshi`
`49`	`48`	`:members:`
`50`		`-:undoc-members:`
`51`	`49`	`:show-inheritance:`
	`50`	`+:special-members: __init__`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit21a6820

File tree

5 files changed

5 files changed

`‎doc/html5lib.filters.rst`

`‎doc/html5lib.rst`

`‎doc/html5lib.treeadapters.rst`

`‎doc/html5lib.treebuilders.rst`

`‎doc/html5lib.treewalkers.rst`

0 commit comments