@@ -31,24 +31,24 @@ mkdocs = loader.load("mkdocs", submodules=False)
3131## Navigating into the loaded objects
3232
3333Both the ` load ` function and the ` GriffeLoader.load ` method
34- return an [ ` Object ` ] [ griffe.dataclasses .Object ] instance.
34+ return an [ ` Object ` ] [ griffe.models .Object ] instance.
3535There are several ways to access members of an object:
3636
3737- through its ` members ` attribute, which is a dictionary,
3838 with the usual ` keys() ` , ` values() ` and ` items() ` methods.
39- - thanks to its ` __getitem__ ` method. For example ` griffe["dataclasses "] `
40- returns the ` Module ` instance representing Griffe's ` dataclasses ` module.
41- Since this module also has members, you can chain calls: ` griffe["dataclasses "]["Module"] ` .
42- Conveniently, you can chain the names with dots in a single call: ` griffe["dataclasses .Module"] ` .
43- You can even pass a tuple instead of a string: ` griffe[("dataclasses ", "Module")] ` .
44- - through the [ ` modules ` ] [ griffe.dataclasses .Object.modules ] ,
45- [ ` classes ` ] [ griffe.dataclasses .Object.classes ] ,
46- [ ` functions ` ] [ griffe.dataclasses .Object.functions ] and
47- [ ` attributes ` ] [ griffe.dataclasses .Object.attributes ] properties,
39+ - thanks to its ` __getitem__ ` method. For example ` griffe["models "] `
40+ returns the ` Module ` instance representing Griffe's ` models ` module.
41+ Since this module also has members, you can chain calls: ` griffe["models "]["Module"] ` .
42+ Conveniently, you can chain the names with dots in a single call: ` griffe["models .Module"] ` .
43+ You can even pass a tuple instead of a string: ` griffe[("models ", "Module")] ` .
44+ - through the [ ` modules ` ] [ griffe.models .Object.modules ] ,
45+ [ ` classes ` ] [ griffe.models .Object.classes ] ,
46+ [ ` functions ` ] [ griffe.models .Object.functions ] and
47+ [ ` attributes ` ] [ griffe.models .Object.attributes ] properties,
4848 which take care of filtering members based on their kind, and return dictionaries.
4949
50- Most of the time, you will only use classes from the [ ` griffe.dataclasses ` ] [ griffe.dataclasses ]
51- and [ ` griffe.docstrings.dataclasses ` ] [ griffe.docstrings.dataclasses ] modules.
50+ Most of the time, you will only use classes from the [ ` griffe.models ` ] [ griffe.models ]
51+ and [ ` griffe.docstrings.models ` ] [ griffe.docstrings.models ] modules.
5252
5353
5454## Class inheritance
@@ -64,7 +64,7 @@ from using inheritance support in Griffe.
6464Griffe supports class inheritance, both when visiting and inspecting modules.
6565
6666To access members of a class that are inherited from base classes,
67- use [ ` Object.inherited_members ` ] [ griffe.dataclasses .Object.inherited_members ] .
67+ use [ ` Object.inherited_members ` ] [ griffe.models .Object.inherited_members ] .
6868If this is the first time you access inherited members, the base classes
6969of the given class will be resolved and cached, then the MRO (Method Resolution Order)
7070will be computed for these bases classes, and a dictionary of inherited members
@@ -94,15 +94,15 @@ If a base class cannot be resolved during computation
9494of inherited members, Griffe logs a DEBUG message.
9595
9696If you want to access all members at once (both declared and inherited),
97- use [ ` Object.all_members ` ] [ griffe.dataclasses .Object.all_members ] .
97+ use [ ` Object.all_members ` ] [ griffe.models .Object.all_members ] .
9898
9999If you want to access only declared members,
100- use [ ` Object.members ` ] [ griffe.dataclasses .Object ] .
100+ use [ ` Object.members ` ] [ griffe.models .Object ] .
101101
102- Accessing [ ` Object.attributes ` ] [ griffe.dataclasses .Object.attributes ] ,
103- [ ` Object.functions ` ] [ griffe.dataclasses .Object.functions ] ,
104- [ ` Object.classes ` ] [ griffe.dataclasses .Object.classes ] or
105- [ ` Object.modules ` ] [ griffe.dataclasses .Object.modules ]
102+ Accessing [ ` Object.attributes ` ] [ griffe.models .Object.attributes ] ,
103+ [ ` Object.functions ` ] [ griffe.models .Object.functions ] ,
104+ [ ` Object.classes ` ] [ griffe.models .Object.classes ] or
105+ [ ` Object.modules ` ] [ griffe.models .Object.modules ]
106106will trigger inheritance computation, so make sure to only call it
107107once everything is loaded by Griffe. Don't access inherited members
108108in extensions, while visiting or inspecting a module.
0 commit comments