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

Add attribute artists_sort to Release class #117

Merged
merged 2 commits into from
Sep 25, 2022
Merged

Add attribute artists_sort to Release class #117

merged 2 commits into from
Sep 25, 2022

Conversation

JOJ0
Copy link
Contributor

@JOJ0 JOJ0 commented Sep 25, 2022

To support a feature request in beetbox/beets: beetbox/beets#4401 (comment), laying out this information via the client might help.

@JOJ0 JOJ0 mentioned this pull request Sep 25, 2022
Closed
AnssiAhola
AnssiAhola approved these changes Sep 25, 2022
View reviewed changes
Copy link
Contributor

@AnssiAhola AnssiAhola left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM!

Is this basically alternative to manually joining artists with artist.fetch("join")?
That's also one field we could add to the Artist model at some point 😅

@JOJ0
Copy link
Contributor Author

JOJ0 commented Sep 25, 2022

No actually it's a way to get the joined artists in a string directly from the api. have a look into the linked beets issue for an example.

@JOJ0
Document artists and artists_sort attributes
dc6ed5b 
of Release class so they get rendered nicely via Sphinx autodoc. To remove the
inherited clutter of undocumented attributes an empty autodoc comment (#:)
was attached to the rest of the classes attributes.
@JOJ0 JOJ0 merged commit 8825a2f into master Sep 25, 2022
@JOJ0
Copy link
Contributor Author

JOJ0 commented Sep 25, 2022 •
edited
Loading

I misread your message @AnssiAhola, yes it definitely is an alternative to manually joining artist with the info found in join! Sorry! Yeah! 😅

I'll open a PR soon adding join to Artist

@JOJ0
Copy link
Contributor Author

JOJ0 commented Sep 25, 2022

Unfortunately even though docs rendering went fine on my machine, it seams we hit an issue again: https://readthedocs.org/projects/python3-discogs-client/builds/18164644/

Will look into another time...

@JOJ0
Copy link
Contributor Author

JOJ0 commented Sep 25, 2022

Fixed it, was an issue in latest Sphinx version. Pinnend it to older one as documented here: readthedocs/sphinx_rtd_theme#1343

@prcutler @AnssiAhola @alifhughes have a look into diff of this PR, this is how we can document class attributes and this is how it looks like rendered:
https://python3-discogs-client.readthedocs.io/en/latest/discogs_client.html#discogs_client.models.Release.artists

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AnssiAhola AnssiAhola AnssiAhola approved these changes

@alifhughes alifhughes Awaiting requested review from alifhughes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@JOJ0 @AnssiAhola