PSyclone icon indicating copy to clipboard operation
PSyclone copied to clipboard

Issues with Reference Guide

Open hiker opened this issue 2 years ago • 0 comments

Quoting @arporter :

Following our discussion on Teams, I had a play and it seems the warnings are to do with classes contained within classes. Therefore, contrary to what I said earlier, I think this is worth a new ticket.

E.g.:

psyclone/src/psyclone/psyir/nodes/operation.py:docstring of psyclone.psyir.nodes.operation.Operator:1: WARNING: duplicate object description of psyclone.psyir.nodes.operation.Operator, other instance in autogenerated/psyclone.psyir.nodes, use :noindex: for one of them

etc.

Additionally, I've created the following code snippet that could be adapted to automatically set __all__ for us:

import sys, inspect
__all__ =[]
for name, obj in inspect.getmembers(sys.modules[__name__]):
    if not name.startswith("_") and inspect.isclass(obj):
        __all__.append(name)

This would remove the need to explicitly list all classes (after importing them in the first place) in __all__ of __init__.py.

hiker avatar Jul 12 '22 01:07 hiker