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

Add export pragmas to smt.h #356

Merged
merged 1 commit into from
Oct 10, 2024
Merged

Add export pragmas to smt.h #356

merged 1 commit into from
Oct 10, 2024

Conversation

CyanoKobalamyne
Copy link
Collaborator

This stops clangd from complaining about unused includes.

This stops clangd from complaining about unused includes.
@CyanoKobalamyne
Copy link
Collaborator Author

Also, if the intention is for users to not include the individual headers referenced in smt.h, then we should probably mark them as private.

https://clangd.llvm.org/design/include-cleaner#umbrella-headers

@yoni206
Copy link
Collaborator

yoni206 commented Oct 9, 2024

Can we instead suppress related warnings through cmake?
If we can, then perhaps this would be more sustainable (the next person that adds an #include might forget to add these pragmas).
What do you think?

@barrettcw
Copy link
Collaborator

Actually, I would be in favor of using these pragmas and also documenting each "internal" header file to say that this file should not be included directly by a user. I think this seems like a better practice than disabling the warnings. If you're worried someone will forget in the future, we could also add some text in a "developer's wiki" explaining this policy.

@yoni206 yoni206 merged commit 48fa688 into main Oct 10, 2024
24 checks passed
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