Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

API documentation should include class properties and data members #150

Open
balazsdukai opened this issue Feb 8, 2025 · 1 comment
Open

API documentation should include class properties and data members #150

balazsdukai opened this issue Feb 8, 2025 · 1 comment

Comments

@balazsdukai
Copy link
Member

For example the FileStoreResource has a file_store property which returns a FileStore instance. The FileStore has a data_dir member. Both file_store and data_dir are crucial for the correct use of this resource, but none of them show up in the compiled api docs in https://innovation.3dbag.nl/3dbag-pipeline/reference/bag3d/common/resources/files/#bag3d.common.resources.files.FileStoreResource
@balazsdukai
Copy link
Member Author

Or maybe reconsider the use of properties and add getter methods e.g. get_data_dir() instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@balazsdukai