Skip to content

Commit 6dd7484

Browse files
dabacondstrain115
authored andcommitted
Fix methods missing from doc strings (#3048)
1 parent 0567d33 commit 6dd7484

File tree

3 files changed

+16
-8
lines changed

3 files changed

+16
-8
lines changed

docs/api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,10 @@ Unitary effects that can be applied to one or more qubits.
6969
cirq.givens
7070
cirq.identity_each
7171
cirq.riswap
72-
cirq.CCNotPowGate
72+
.. autoclass:: cirq.CCNotPowGate
7373
cirq.CCXPowGate
7474
cirq.CCZPowGate
75-
cirq.CNotPowGate
75+
.. autoclass:: cirq.CNotPowGate
7676
cirq.CSwapGate
7777
cirq.CXPowGate
7878
cirq.CZPowGate
@@ -251,7 +251,7 @@ results.
251251
cirq.ExpressionMap
252252
cirq.Linspace
253253
cirq.ListSweep
254-
cirq.ParamDictType
254+
.. autoclass:: cirq.ParamDictType
255255
cirq.ParamResolver
256256
cirq.ParamResolverOrSimilarType
257257
cirq.PauliSumCollector

docs/conf.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,14 @@ def autodoc_skip_member(
7777
) -> bool:
7878
"""Public members already kept. Also include members marked as documented.
7979
"""
80-
return id(obj) not in _doc.RECORDED_CONST_DOCS
80+
# Never skip if explicitly whitelisted.
81+
if id(obj) in _doc.RECORDED_CONST_DOCS:
82+
return False
83+
# Skip all private methods.
84+
if name.startswith('_'):
85+
return True
86+
# Fallback to default.
87+
return skip
8188

8289

8390
def autodoc_process(app, what: str, name: str, obj: Any, options,

docs/docs_coverage_test.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import inspect
2-
from pathlib import Path
2+
import pathlib
3+
import re
34
from typing import Set, Dict, Tuple, Any, List
45

56
import cirq
@@ -43,14 +44,14 @@ def _api_rst_fullnames_per_section() -> List[List[str]]:
4344
result: List[List[str]] = []
4445
section: List[str] = []
4546
seen: Set[str] = set()
46-
with open(Path(__file__).parent / 'api.rst', mode='r') as f:
47+
with open(pathlib.Path(__file__).parent / 'api.rst', mode='r') as f:
4748
for line in f.readlines():
4849
if line.strip() == '.. autosummary::':
4950
if section:
5051
result.append(section)
5152
section = []
52-
elif line.startswith(' cirq.'):
53-
fullname = line.strip()
53+
elif ' cirq.' in line or ' .. autoclass:: cirq.' in line:
54+
fullname = line[line.find('cirq'):].strip()
5455
if fullname in seen:
5556
# coverage: ignore
5657
raise ValueError(f'{fullname} appears twice in api.rst')

0 commit comments

Comments
 (0)