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

Updated docs for conan new --template #1752

Merged
merged 2 commits into from Jul 1, 2020
Merged

Updated docs for conan new --template #1752

merged 2 commits into from Jul 1, 2020

Conversation

TheQwertiest
Copy link
Contributor

@TheQwertiest TheQwertiest commented Jun 29, 2020

Docs for the following feature: conan-io/conan#7215
Note: command line --help output was not updated, because it appears that it's heavily outdated for a lot of files anyway (i.e. commands_help_update.py changes a lot of files).

Docs for the following feature: conan-io/conan#7215
Note: command line `--help` output was not updated, because it appears that it's heavily outdated for a lot of files anyway (i.e. `commands_help_update.py` changes a lot of files).
@czoido czoido added this to the 1.27 milestone Jul 1, 2020
@czoido czoido requested a review from jgsogo Jul 1, 2020
reference/commands/creator/new.rst Outdated Show resolved Hide resolved
Co-authored-by: Javier G. Sogo <jgsogo@gmail.com>
@TheQwertiest
Copy link
Contributor Author

@TheQwertiest TheQwertiest commented Jul 1, 2020

@jgsogo , but that is not consistent with the current implementation? Currently it's a string and not an object.

@TheQwertiest
Copy link
Contributor Author

@TheQwertiest TheQwertiest commented Jul 1, 2020

I.e. documentation should reflect the current state and not the state of the future release. It will just confuse (and mislead) users otherwise.

@jgsogo
Copy link
Member

@jgsogo jgsogo commented Jul 1, 2020

IMO, documentation should reflect how you are allowed to use something, in this case the important bit is that it renders as a version string (this is the only thing you should do with it right now), saying it is a string is a very strong commitment.
If we say it is a string, someone could write:

{% set major = conan_version.split('.', 1)[0] %}
{% if major > 1 %}
   This is Conan v2!
{% endif %}

and that will block us from passing any other object type (it would be a regression). If we say it renders as a string, the previous snippet should use the str-cast and it won't break if we change the actual string for a Version object.

jgsogo
jgsogo approved these changes Jul 1, 2020
@czoido czoido merged commit 52ecf53 into conan-io:develop Jul 1, 2020
2 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.

None yet

4 participants