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

conan-io / examples2

Conan 2.x examples

MIT License

87 stars 48 forks source link

Closed czoido closed 5 months ago

czoido commented 6 months ago

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: https://github.com/conan-io/examples2/issues/130 Related: https://github.com/conan-io/docs/issues/3631

czoido commented 5 months ago

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)