Generic function to check if all classes defined in `src_path` are documented in `doc_path`. Returns a set of undocumented class names.
(doc_path, src_path, doc_regex, src_regex, exclude_conditions=None)
| 52 | |
| 53 | |
| 54 | def check_documentation(doc_path, src_path, doc_regex, src_regex, exclude_conditions=None): |
| 55 | """ |
| 56 | Generic function to check if all classes defined in `src_path` are documented in `doc_path`. |
| 57 | Returns a set of undocumented class names. |
| 58 | """ |
| 59 | documented = set(read_documented_classes(doc_path, doc_regex)) |
| 60 | source_classes = set(read_source_classes(src_path, src_regex, exclude_conditions=exclude_conditions)) |
| 61 | |
| 62 | # Find which classes in source are not documented in a deterministic way. |
| 63 | undocumented = sorted(source_classes - documented) |
| 64 | return undocumented |
| 65 | |
| 66 | |
| 67 | if __name__ == "__main__": |
searching dependent graphs…