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

[BUG] Documenting a set() command with PARENT_SCOPE (or other flags) generates incorrect documentation #155

Open
AutonomicPerfectionist opened this issue May 16, 2023 · 0 comments · May be fixed by #157
Labels
bug Something isn't working

Comments

@AutonomicPerfectionist
Copy link
Contributor

AutonomicPerfectionist commented May 16, 2023

Describe the bug
Documenting the following command:

set(MyString "String" PARENT_SCOPE)

Documents the variable MyString as a List with the initial values String PARENT_SCOPE

Expected behavior
We should probably check for the PARENT_SCOPE flag, remove it from the type
and default value calculations, and flag it in the generated documentation.
I think adding a note that it sets in the parent scope should be sufficient.

I believe this affects other set() flags like CACHE

@AutonomicPerfectionist AutonomicPerfectionist added the bug Something isn't working label May 16, 2023
@AutonomicPerfectionist AutonomicPerfectionist changed the title [BUG] Documenting a set() command with PARENT_SCOPE generates incorrect documentation [BUG] Documenting a set() command with PARENT_SCOPE (or other flags) generates incorrect documentation May 16, 2023
@AutonomicPerfectionist AutonomicPerfectionist linked a pull request May 17, 2023 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
1 participant