]> git.ipfire.org Git - thirdparty/git.git/commit - notes.h
notes: move the documentation to the struct
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Mon, 5 Jun 2023 10:05:23 +0000 (12:05 +0200)
committerJunio C Hamano <gitster@pobox.com>
Tue, 6 Jun 2023 00:35:05 +0000 (09:35 +0900)
commitaeee1408ce98f0527d9d22c3aee96360f341443b
tree93ec2e68498ea28656abcf3994c502b2d2ce9f3d
parenta2e9dbb8849a29d010dceea2d5d1cab62d4dee6d
notes: move the documentation to the struct

Its better to document the struct members directly instead of on a
function that takes a pointer to the struct. This will also make it
easier to update the documentation in the future.

Make adjustments for this new context. Also drop “may contain” since we
don’t need to emphasize that a list could be empty.

Suggested-by: Jeff King <peff@peff.net>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
notes.h