Skip to content

Commit

Permalink
chore: fix some comments (#3114)
Browse files Browse the repository at this point in the history
Signed-off-by: luozexuan <[email protected]>
  • Loading branch information
luozexuan authored Aug 12, 2024
1 parent cf85450 commit c19cf62
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Syft's core library is implemented in the `syft` package and subpackages, where
- the `syft` package contains a single function that can take a `source.Source` object and catalog it, producing an `sbom.SBOM` object
- the `syft/format` package contains the ability to encode and decode SBOMs to and from different SBOM formats (such as SPDX and CycloneDX)

The `cmd` pacakge at the highest level execution flow wires up [`spf13/cobra`](https://github.com/spf13/cobra) commands for execution in the main application:
The `cmd` package at the highest level execution flow wires up [`spf13/cobra`](https://github.com/spf13/cobra) commands for execution in the main application:
```mermaid
sequenceDiagram
participant main as cmd/syft/main
Expand Down
2 changes: 1 addition & 1 deletion cmd/syft/internal/options/format.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ if false, uses the syft-json output for templating (which follows the syft JSON
Note: long term support for this option is not guaranteed (it may change or break at any time)`)

prettyDescription := `include space indention and newlines
prettyDescription := `include space indentation and newlines
note: inherits default value from 'format.pretty' or 'false' if parent is unset`
descriptions.Add(&o.SyftJSON.Pretty, prettyDescription)
descriptions.Add(&o.SPDXJSON.Pretty, prettyDescription)
Expand Down
2 changes: 1 addition & 1 deletion internal/cache/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Caching

All caches are created from a global `manager`. By defaut this is a `bypassedCache`, which performs no caching.
All caches are created from a global `manager`. By default this is a `bypassedCache`, which performs no caching.
One benefit of this is that tests don't need to worry about caching causing issues unless they explicitly need
to test the cache and can opt-in using the `cache.TestCache(t)` helper.

Expand Down
2 changes: 1 addition & 1 deletion test/cli/cyclonedx_valid_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import (
"github.com/anchore/syft/syft/format/cyclonedxjson"
)

// We have schema validation mechanims in schema/cyclonedx/
// We have schema validation mechanisms in schema/cyclonedx/
// This test allows us to double check that validation against the cyclonedx-cli tool
func TestValidCycloneDX(t *testing.T) {
imageFixture := func(t *testing.T) string {
Expand Down

0 comments on commit c19cf62

Please sign in to comment.