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

Checkpoint to make sure config file is set up correctly added to the getting started guide #4820

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

miertla
Copy link

@miertla miertla commented Jun 15, 2023

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

  • Documentation. (If you've add a new command-line flag, for example, find the appropriate page under docs/ to describe it.)
  • Changelog. (Add an entry to docs/changelog.rst near the top of the document.)
  • Tests. (Encouraged but not strictly required.)

Copy link
Member

@sampsyo sampsyo left a 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.

Comment on lines +185 to +189
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.
Copy link
Member

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.

Copy link
Member

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!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment on lines +185 to +189
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

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.

3 participants