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

Clarify that run_example files are not mean to be run by the user, they are for ci #134

Closed
czoido opened this issue Feb 16, 2024 · 1 comment · Fixed by #139
Closed

Clarify that run_example files are not mean to be run by the user, they are for ci #134

czoido opened this issue Feb 16, 2024 · 1 comment · Fixed by #139

Comments

@czoido
Copy link
Contributor

czoido commented Feb 16, 2024

We could add a comment to the files or something in the docs or any other soltion but I think it can be confusing for users finding them in the folder.
Related: #130
Related: conan-io/docs#3631

@czoido
Copy link
Contributor Author

czoido commented Mar 15, 2024

I think we could do a couple of things here:

  • Change the name of the files to something less inviting to be run than run_example.py
  • Check an environment variable that's set in the CI and output a message if it's not set (just a warning, do not fail)

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 a pull request may close this issue.

1 participant