improve doc comments

Signed-off-by: Alex Goodman <alex.goodman@anchore.com>
This commit is contained in:
Alex Goodman
2020-11-17 12:37:13 -05:00
parent 62b03f3a91
commit c892c3609e
46 changed files with 191 additions and 83 deletions
+1 -2
View File
@@ -34,7 +34,6 @@ type artifactMetadataUnpacker struct {
}
func NewArtifact(p *pkg.Package) (Artifact, error) {
return Artifact{
artifactBasicMetadata: artifactBasicMetadata{
Name: p.Name,
@@ -67,6 +66,7 @@ func (a Artifact) ToPackage() pkg.Package {
}
}
// nolint:funlen
func (a *Artifact) UnmarshalJSON(b []byte) error {
var basic artifactBasicMetadata
if err := json.Unmarshal(b, &basic); err != nil {
@@ -128,7 +128,6 @@ func (a *Artifact) UnmarshalJSON(b []byte) error {
// there may be packages with no metadata, which is OK
default:
return fmt.Errorf("unsupported package metadata type: %+v", a.MetadataType)
}
return nil
-1
View File
@@ -55,7 +55,6 @@ func (s *Source) UnmarshalJSON(b []byte) error {
s.Target = payload
default:
return fmt.Errorf("unsupported package metadata type: %+v", s.Type)
}
return nil
@@ -14,7 +14,7 @@
"MIT"
],
"language": "python",
"metadataType": "python-package-metadata",
"metadataType": "PythonPackageMetadata",
"metadata": {
"name": "package-1",
"version": "1.0.1",
@@ -37,7 +37,7 @@
],
"licenses": null,
"language": "",
"metadataType": "dpkg-metadata",
"metadataType": "DpkgMetadata",
"metadata": {
"package": "package-2",
"source": "",
@@ -15,7 +15,7 @@
"MIT"
],
"language": "python",
"metadataType": "python-package-metadata",
"metadataType": "PythonPackageMetadata",
"metadata": {
"name": "package-1",
"version": "1.0.1",
@@ -39,7 +39,7 @@
],
"licenses": null,
"language": "",
"metadataType": "dpkg-metadata",
"metadataType": "DpkgMetadata",
"metadata": {
"package": "package-2",
"source": "",
+2
View File
@@ -10,11 +10,13 @@ import (
"github.com/anchore/syft/syft/source"
)
// Presenter is a human-friendly text presenter to represent package and source data.
type Presenter struct {
catalog *pkg.Catalog
srcMetadata source.Metadata
}
// NewPresenter creates a new presenter for the given set of catalog and image data.
func NewPresenter(catalog *pkg.Catalog, srcMetadata source.Metadata) *Presenter {
return &Presenter{
catalog: catalog,