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.

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

Complete core documentation #150

Merged
merged 1 commit into from
Aug 2, 2024
Merged

Complete core documentation #150

merged 1 commit into from
Aug 2, 2024

Conversation

ntadej
Copy link
Collaborator

@ntadej ntadej commented Aug 2, 2024

Complete core documentation and mark private classes as private to silence warnings.

Enable warnings as errors to ensure all future public code is documented.

@ntadej ntadej requested review from louwers, HarelM and birkskyum August 2, 2024 05:00
@louwers
Copy link
Collaborator

louwers commented Aug 2, 2024

Enable warnings as errors to ensure all future public code is documented.

Oh that's nice. Maybe we should enable this for the core as well, even though it is not really a C++ library.

@ntadej
Copy link
Collaborator Author

ntadej commented Aug 2, 2024

Enable warnings as errors to ensure all future public code is documented.

Oh that's nice. Maybe we should enable this for the core as well, even though it is not really a C++ library.

It may be a lot of work on a large codebase as core as every class needs to be either fully documented or marked as private.

@ntadej ntadej merged commit ec25893 into maplibre:main Aug 2, 2024
39 checks passed
@ntadej ntadej deleted the docs-core branch August 2, 2024 14:50
@ntadej ntadej added this to the 3.0 milestone Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants