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.

Sign up for GitHub

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

Jump to bottom

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
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93504f0
Added a quick checkpoint to ensure the config file is set up correctl…
miertla Jun 15, 2023
14646b7
Update changelog.rst
miertla Jun 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,8 @@ Other changes:
:bug:`4585`
* :doc:`/faq`: :ref:`multidisc`: Elaborated the multi-disc FAQ :bug:`4806`
* :doc:`/faq`: :ref:`src`: Removed some long lines.
* :doc:`/guides/main`: Added a quick checkpoint to ensure the config file is
set up correctly prior to users importing their music library.

1.6.0 (November 27, 2021)
-------------------------
Expand Down
7 changes: 7 additions & 0 deletions docs/guides/main.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,13 @@ here, including the directory and file naming scheme. See

.. _YAML: https://yaml.org/

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

@miertla?

Comment on lines +185 to +189
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



Importing Your Library
----------------------

Expand Down