Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Subtle hint that topics is not a keyword #10849

Merged
merged 1 commit into from
Aug 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
2 changes: 2 additions & 0 deletions doc/changes/10849.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Tweak the preset value for tags in the `dune-project` file to hint at topics
not having a special meaning. (#10849, @punchagan)
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 <[email protected]>"]
authors: ["Author Name <[email protected]>"]
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 <[email protected]>"]
authors: ["Author Name <[email protected]>"]
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
Loading