docs: Specify how hiding on top level items works

3 jobs for project-overrides in 2 minutes and 53 seconds
Status Name Job ID Coverage
  Check
passed flake8 #1216855

00:01:41

failed mypy #1216856
allowed to fail

00:02:52

passed reuse #1216857

00:01:48

 
Name Stage Failure
failed
mypy Check
gidocgen/gir/parser.py:925: error: Argument "get_type" to "GType" has incompatible type "Optional[str]"; expected "str"
gidocgen/gir/parser.py:968: error: Argument "get_type" to "GType" has incompatible type "Optional[str]"; expected "str"
gidocgen/gir/parser.py:990: error: Argument "name" to "Union" has incompatible type "Optional[str]"; expected "str"
gidocgen/gir/parser.py:990: error: Argument "symbol_prefix" to "Union" has incompatible type "Optional[str]"; expected "str"
gidocgen/gir/parser.py:990: error: Argument "ctype" to "Union" has incompatible type "Optional[str]"; expected "str"
gidocgen/utils.py:767: error: Need type annotation for 'found_programs' (hint: "found_programs: Dict[<type>, <type>] = ...")
Found 186 errors in 4 files (checked 17 source files)
Cleaning up file based variables
ERROR: Job failed: exit code 1