Add documentation_url to the Package Class #4099
Open
Conversation
This file contains hidden or 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
Signed-off-by: Asim kumar <aktech701@gmail.com>
Signed-off-by: Asim kumar <aktech701@gmail.com>
|
I’ve raised a pull request addressing the issue “add documentation_url to the Package class”. The changes include:
Thank you! 😊 |
AyanSinhaMahapatra
requested changes
Apr 4, 2025
There was a problem hiding this comment.
@asimchoudhary Thanks for the PR.
- Please read the contribution docs: https://scancode-toolkit.readthedocs.io/en/stable/contribute/contrib_dev.html#running-tests you have info on how to regenerate tests to pass tests after you added changes.
- Please read the original issue properly: Consider adding new documentation_url to Package model #4092 (comment) you also have to collect this field in the respective datafilehandlers for manifests where this is present (and review others from the reference URLs for the spec)
See also comments for specific feedback
| @@ -1633,10 +1639,11 @@ def to_package_data(self): | |||
| mapping.pop('package_uid', None) | |||
| mapping.pop('datafile_paths', None) | |||
| mapping.pop('datasource_ids', None) | |||
| mapping.pop('documentation_url', None) | |||
There was a problem hiding this comment.
This is not required. Please remove
| return PackageData.from_dict(mapping) | ||
|
|
||
| @classmethod | ||
| def from_package_data(cls, package_data, datafile_path=None, package_only=False): | ||
| def from_package_data(cls, package_data, datafile_path=None, package_only=False , documentation_url=None): |
There was a problem hiding this comment.
These changes are not correct, please remove. You have to make the changes in the individual datafile handlers, this is a generic function used to create top-level Package objects from PackageData. All common attributes are inherited automatically
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.
Fixes #4092
Tasks
Run tests locally to check for errors.