-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
Checkpoint to make sure config file is set up correctly added to the getting started guide #4820
base: master
Are you sure you want to change the base?
Conversation
…y prior to users importing their music library
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not a bad idea to have something like this! I have a suggestion for keeping this short and to the point; let me know what you think.
To check that your config file is set up correctly run ``beet version``. This should return your | ||
beets version, Python version, and a list of installed plugins. If no plugins are displayed, but | ||
there are plugins listed in your config file go back to the steps above to set up the config | ||
file properly before importing your music library. You can also run ``beet config`` which will | ||
display more in-depth details about each enabled plugin. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about this slightly simplified version?
To check that you've set up your configuration how you want it, you can type
``beet version`` to see a list of enabled plugins or ``beet config`` to get a
complete listing of your current configuration.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@miertla what do you think of sampsyo's suggestion? If you like it, do you have a minute to update your pull request. I would press the merge button then :-) Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To check that your config file is set up correctly run ``beet version``. This should return your | ||
beets version, Python version, and a list of installed plugins. If no plugins are displayed, but | ||
there are plugins listed in your config file go back to the steps above to set up the config | ||
file properly before importing your music library. You can also run ``beet config`` which will | ||
display more in-depth details about each enabled plugin. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To check that your config file is set up correctly run ``beet version``. This should return your | |
beets version, Python version, and a list of installed plugins. If no plugins are displayed, but | |
there are plugins listed in your config file go back to the steps above to set up the config | |
file properly before importing your music library. You can also run ``beet config`` which will | |
display more in-depth details about each enabled plugin. | |
To check that you've set up your configuration how you want it, you can type | |
``beet version`` to see a list of enabled plugins or ``beet config`` to get a | |
complete listing of your current configuration. |
Adding @sampsyo's idea as a suggestion
Description
Added a quick checkpoint to ensure the config file is set up correctly prior to users importing their music library. This was something I discovered later after running into an issue with my config file and hope it helps new users avoid the issues I had.
To Do
docs/
to describe it.)docs/changelog.rst
near the top of the document.)