update docs

This commit is contained in:
Arpad Ryszka 2025-08-08 21:45:51 +02:00
parent b130b3dcd8
commit 9c9d65a43c

View File

@ -12,7 +12,7 @@ Declarations:
- the declarations must be absolute Go paths - the declarations must be absolute Go paths
- when passing in the import path of a package, all the top level symbols of the package, plus the struct fields and methods of the - when passing in the import path of a package, all the top level symbols of the package, plus the struct fields and methods of the
top level types will be included top level types will be included
- the package documentation can be fetched using docreflect.Docs("absolute/import/path/of/package") - the package documentation can be fetched using `docreflect.Docs("absolute/import/path/of/package")`
- when passing in the import path of only the selected symbols, the rest of the package level symbols will be ignroed - when passing in the import path of only the selected symbols, the rest of the package level symbols will be ignroed
Library documentation: https://godocs.io/code.squareroundforest.org/arpio/docreflect Library documentation: https://godocs.io/code.squareroundforest.org/arpio/docreflect