Skip to content

Commit

Permalink
Subtle hint that topics is not a keyword
Browse files Browse the repository at this point in the history
Number of projects in the opam-repository have the word topics as one of
the tags, presumably because of the structure of the `tags` sexp in the
dune-project file generated on `dune init`. See ocurrent/opam-ci-check#26

Signed-off-by: Puneeth Chaganti <[email protected]>
  • Loading branch information
punchagan committed Aug 27, 2024
1 parent 5607dd9 commit 71b2a19
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion bin/dune_init.ml
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ module Component = struct
~dir
~synopsis:(Some "A short synopsis")
~description:(Some "A longer description")
~tags:[ "topics"; "to describe"; "your"; "project" ]
~tags:[ "add topics"; "to describe"; "your"; "project" ]
~depends:
[ { Package_dependency.name = Package.Name.of_string "ocaml"
; constraint_ = None
Expand Down
8 changes: 4 additions & 4 deletions test/blackbox-tests/test-cases/dune-init.t/run.t
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ In particular, the `dune-project` file has the expected content:
(description "A longer description")
(depends ocaml dune)
(tags
(topics "to describe" your project)))
("add topics" "to describe" your project)))

; See the complete stanza docs at https://dune.readthedocs.io/en/stable/reference/dune-project/index.html

Expand All @@ -379,7 +379,7 @@ And the opam file will be generated as expected
maintainer: ["Maintainer Name"]
authors: ["Author Name"]
license: "LICENSE"
tags: ["topics" "to describe" "your" "project"]
tags: ["add topics" "to describe" "your" "project"]
homepage: "https://github.com/username/reponame"
doc: "https://url/to/documentation"
bug-reports: "https://github.com/username/reponame/issues"
Expand Down Expand Up @@ -469,7 +469,7 @@ In particular, the `dune-project` file has the expected content:
(description "A longer description")
(depends ocaml dune)
(tags
(topics "to describe" your project)))
("add topics" "to describe" your project)))

; See the complete stanza docs at https://dune.readthedocs.io/en/stable/reference/dune-project/index.html

Expand All @@ -489,7 +489,7 @@ And the opam file will be generated as expected
maintainer: ["Maintainer Name"]
authors: ["Author Name"]
license: "LICENSE"
tags: ["topics" "to describe" "your" "project"]
tags: ["add topics" "to describe" "your" "project"]
homepage: "https://github.com/username/reponame"
doc: "https://url/to/documentation"
bug-reports: "https://github.com/username/reponame/issues"
Expand Down

0 comments on commit 71b2a19

Please sign in to comment.