Added some docs and adjusted field names for ease of use in DocDetails #440
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dosubot
bot
added
the
size:M
whitead
requested review from
jamesbraza and
mskarlin
and removed request for
jamesbraza
jamesbraza
approved these changes
Sep 19, 2024
| description="string indicating license." | ||
| " Should refer specifically to pdf_url (since that could be preprint). None means unknown/unset.", | ||
| ) | ||
| pdf_url: str | None = None |
There was a problem hiding this comment.
What do you think of calling this source_url over pdf_url, as we'll someday generalize beyond PDFs
There was a problem hiding this comment.
I think doi_url should cover the HTML/WEB url and pdf_url should directly go to PDF. We may later add source_url and then I think doi_url would be depcretaed rather than pdf_url
| ) | ||
| if self.source_quality_str: | ||
| return ( | ||
| f"{self.citation} This article has {self.citation_count} citations and is" |
There was a problem hiding this comment.
Does self.citation have a newline at the end of it?
There was a problem hiding this comment.
should not have that
mskarlin
reviewed
Sep 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just promoted some fields I thought were useful:
licenseandpdf_url. These can be provided by S2 client at some point, but for now they come from unpaywall.Also added to README: https://github.com/Future-House/paper-qa/tree/doc-details-docs?tab=readme-ov-file#using-clients-directly