-
Notifications
You must be signed in to change notification settings - Fork 55
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 documentation for v2 and v3 CLI/API differences #240
Comments
I'm happy for you to take it on if you like. It's been nagging at me for a while, so it would be great to get it clear enough that no new issues arise. I wonder if a fake (my plan was that v0.3 is at least kind of backwards-compatible via wrappers with the same names as the v2 scripts…) |
What do you mean by a fake script? Like just an example script that comes with the installation? Heavily commented? |
Essentially a script that, when called, does nothing but give a message to the user that they have v2 installed, but are trying to use a CLI command that only works in v3, and points them gently to some online documentation. |
So, one that runs if they try to call |
The way I think we could make it work is via We could define an setuptools.setup(
[...]
entry_points={
"console_scripts": [
"pyani = pyani.pyani_tools:pyani_error_msg",
]
},
[...]
) and, in def pyani_error_msg():
msg = "This is the message for the user"
sys.stdout.write(msg) |
The approach above would point |
Removes outdated references to v0.1 Adds additional information for installation of v0.2 using conda, pip, and from downloaded source code. Hopefully this is clearer. Adds a more strident notice about the relationship between 0.2 and 0.3 (0.2 maintenance-only; default repo is 0.3; etc.) Updated copyright years
Removes outdated references to v0.1 Adds additional information for installation of v0.2 using conda, pip, and from downloaded source code. Hopefully this is clearer. Adds a more strident notice about the relationship between 0.2 and 0.3 (0.2 maintenance-only; default repo is 0.3; etc.) Updated copyright years
Updates installation instructions with an emphasis on clarifying that the default repository branch is the development version (v0.3) and that conda/pip will install v0.2.
Removes outdated references to v0.1 Adds additional information for installation of v0.2 using conda, pip, and from downloaded source code. Hopefully this is clearer. Adds a more strident notice about the relationship between 0.2 and 0.3 (0.2 maintenance-only; default repo is 0.3; etc.) Updated copyright years
Updates installation instructions with an emphasis on clarifying that the default repository branch is the development version (v0.3) and that conda/pip will install v0.2.
@widdowquinn
This is one of the first things I think needs to be done; I've seen at least five separate instances (like #238 just now) of the exact same conversation where people try to use pyani v0.3+ commands with pyani v0.2.10. I ran into some confusion there myself when I was going over it. Seems like it would save time all around.
I'll assign it to myself (to work on in a few weeks), unless you want to do it?
The text was updated successfully, but these errors were encountered: