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

Reflect changes in new P2Rank version in tutorials #1

Closed
skodapetr opened this issue Nov 15, 2020 · 2 comments
Closed

Reflect changes in new P2Rank version in tutorials #1

skodapetr opened this issue Nov 15, 2020 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@skodapetr
Copy link
Member

skodapetr commented Nov 15, 2020

For example -conservation_dir param was replaced with -conservation_dirs.
I do not have full list of changes.
We should also update the results for model.

@skodapetr skodapetr added the documentation Improvements or additions to documentation label Jan 11, 2021
@davidjakubec
Copy link
Contributor

Hi,

I think that this Issue is part of a broader problem with the documentation/tutorials being distributed through several channels (e.g., prank -h, @rdk/p2rank README, this wiki) . This is related to issues rdk/p2rank#47 and rdk/p2rank#48 in @rdk/p2rank. As a new user, it is not clear which of the documentations is up-to-date and which should I follow. For example, should I use -m or -model and what does the option actually do in combination with -c? Should I specify the file extension .groovy when selecting a configuration? These are some of the questions I was left wondering. Though they may seem stupid or harmless, they may not be so, as p2rank does not validate the input arguments (rdk/p2rank#36) -- therefore, if a user does not use the correct, up-to-date option/argument name, no error is displayed and they won't find out unless they check the logs (and they will then only identify the issue if they know what to look for). The -conservation_dirs issue described here is a specific example of this: if the old -conservation_dir option is used, the specified directory is not used in any way.

I think it would make sense to have a discussion about what each documentation channel should entail -- e.g., should @rdk/p2rank be self-contained, or should it point to the wiki for turorials? Or, if there are no human resources to keep several documentations up-to-date, I think it would make sense to at least get rid of the obsolete/redundant pages.

David

@skodapetr
Copy link
Member Author

We agreed that the documentation should reflect, and explicitly state, the last release.

@skodapetr skodapetr self-assigned this Mar 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants