Tidy up pytket.circuit API docs
#1178
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| import inspect | ||
| import re | ||
|
|
||
| from pytket._tket.circuit import Circuit | ||
|
|
||
| # This script is used to check that no methods or properties of | ||
| # the Circuit class are left out in the circuit_class.rst file. | ||
|
|
||
| with open("circuit_class.rst", "r", encoding="utf-8") as file: | ||
| rst = file.read() | ||
|
|
||
| in_methods = {p[0] for p in inspect.getmembers(Circuit)} | ||
| pattern = re.compile(r"(?:\bautomethod\b|\bautoproperty\b):: (\w+)\n") | ||
| in_docs = set(pattern.findall(rst)) | ||
| missing = in_methods - in_docs | ||
| print([s for s in missing if not s.startswith("_")]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we put a couple of lines of commentary at the top of this file to explain what it does and why?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.