Should support doc: #35
Description
This supports docs: already, which seems more widely used and, unlike doc:, is suggested as an additional type in the conventional commits specification.
However, gitoxide is a major user of cargo-smart-release. In gitoxide, both docs: and doc: have been used, but doc: seems to be used more often, and seems possibly to be preferred in that project. In gitoxide:
$ git log --oneline | grep -F docs:
687322b45 docs: specify ThreadSafeRepository is not Send/Sync without "parallel"
90588b273 docs: add Exherbo Linux install instructions in README.md
e51b6b624 docs: fix typo
266c9fc53 docs: clarify how `Reference::peeled` is working.
02c465998 docs: fix minor typos
cc48c35d0 docs: fix minor typos
39ed9eda6 docs: fix typos
e9f83ee2f docs: Provide more information to specifically discourage using `gitoxide-core` (#591)
$ git log --oneline | grep -F doc:
426c669d5 doc: Expand `from_fs` doc
4e7306e9f doc: Revise and somewhat expand `Prepare` docs
d731a1cb8 doc: Clarify description of `single` escaping
9db21601b doc: make really clear that `Repository::worktrees()` lists linked worktrees.
df4874bf8 doc: link to latest version in "git2" docs.rs search
c4e87454b doc: inform about tree to index "status"
c06a57e69 doc: Clarify and expand descriptions of `NonFile`s
2fdbcfe17 doc: Fix code fences in gix-merge `ConflictStyle` and `Driver`
b1685a067 doc: Remove a couple obsolete planned items
991c93915 doc: Update "cmp" links in `tree::function::diff`
65f69f72a doc: Fix some broken links to commit/blob URLs
64ff0a770 doc: Update gitoxide repository URLs
3b173054c doc: Fix description of `gix_testtools::Env::unset`
786bfec7c doc: Unify style in config support info
26748ddbe doc: make tree-diff more easily discoverable when coming from `git2`
0b0e871d9 doc: update docker docs assuming blank slate
0c06fc77a doc: Update README for docker integration
b6a67d7fe doc: make clear that indices can contain invalid or dangerous paths.
8d610ab8d doc: make clear that `Time::seconds` is UTC.
f478a3722 doc: inform about the absence of strict hash verification and strict object creation.
832b34570 doc: improve documentation of `common_prefix()` and `pattern_matching_relative_path()`.
ae298262a doc: make clear that locks can leak and what that means on acquiring a lock (#1026)
a8b227ebe doc: Improve documentation to make possibility of leaks more clear (#1026)
e022096aa doc: add note about the trust-model.
5b5983a96 doc: make clear that `normalize()` does not touch duplicate path separators nor single `.`.
5f6cf22cd doc: improve documentation about the `Change` type.
fb63f3f07 doc: Add incomplete mapping of typical `git2` functions and their counterpart in `gix`.
3c8e3c1e8 doc: make clear what can happen if rewrite-tracking isn't disabled if it is not desired.
4deea8a9c doc: Add information on how to turn `LazyCommit` into commit.
f0ddc3b9c doc: `gix::revision::walk::Platform` now informas about the commitgraph.
87f5621d9 doc: make clear that `gix::discover()` isn't suited for authentication remote operations. (#787)
9fabfc500 doc: explain how it's possible to deal with the first commit when comparing trees (#676)
4ebe2ac05 doc: Actively discourage using `Boolean::try_from("")` explicitly.
Currently, doc: seems not to be treated specially. This can be seen in the code:
I think it can also be seen in the including of doc: under "Other" rather than "Documentation" in generated changelogs. For example, in the gitoxide changelog:
### Other
- <csr-id-786bfec7c2cf25a68705b6ef09ba6390600742b8/> Unify style in config support info
This builds on b31d6b7 (#1531) by adjusting the capitalization and
quoting style of string arguments in `progress.rs` that help
document the status of what configuration options are and are not
planned.
- Since I believe these strings are not usually rendered as
Markdown, and most places that code formatting in Markdown would
be used were already written with single quotes, this applies
that quoting style consistently.
- This applies initial capitalization, which was sometimes but not
always done. It does not apply a consistent style for when a
string will end in a `.`, which seems already to differ
deliberately for reasons of clarity. That can be adjusted later.
- A small amount of minor rewording for clarity is also included.That change is due to the doc: commit GitoxideLabs/gitoxide@786bfec, where I had used doc: based on idea that it was the best convention to use in gitoxide when titling commits making documentation changes, discussed in GitoxideLabs/gitoxide#1537 and GitoxideLabs/gitoxide#1531.
An alternative to adding doc: could be for gitoxide to stop using it. Optionally its absence could be documented here, though I don't know if that would be necessary, since overall, outside of gitoxide, docs: seems much more popular than doc:.
As shown above in the first code fragment shown, cargo-smart-release does support or attempt to support at least one other alias, added: for add:. Based on that it seems like adding doc: should be easy, if it is wanted. But I'm not sure added: really works properly, since it is listed in one place and not the others (one of which is noted as having to be updated whenever the first place, where it is listed, is updated). Because of that I'm not what the correct way would be to add doc: with the same meaning as docs:.