[0/4] A couple of fixes for the Trace2 documentation

Message

Linus Arver via GitGitGadget March 10, 2022, 1:35 p.m. UTC

While verifying a suggestion for a contributor before sending it, I noticed
that the Trace2 documentation contained an incorrect example. Looking
around, I found a couple other things I wanted to fix, so here are the
patches.

Johannes Schindelin (4):
  trace2 docs: a couple of grammar fixes
  trace2 docs: surround more terms in backticks
  trace2 docs: fix a JSON formatted example
  trace2 docs: clarify what `varargs` is all about

 Documentation/technical/api-trace2.txt | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)


base-commit: 1a4874565fa3b6668042216189551b98b4dc0b1b
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1172%2Fdscho%2Ffix-trace2-docs-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1172/dscho/fix-trace2-docs-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1172

Comments

Jeff Hostetler March 10, 2022, 1:50 p.m. UTC | #1

On 3/10/22 8:35 AM, Johannes Schindelin via GitGitGadget wrote:
> While verifying a suggestion for a contributor before sending it, I noticed
> that the Trace2 documentation contained an incorrect example. Looking
> around, I found a couple other things I wanted to fix, so here are the
> patches.
> 
> Johannes Schindelin (4):
>    trace2 docs: a couple of grammar fixes
>    trace2 docs: surround more terms in backticks
>    trace2 docs: fix a JSON formatted example
>    trace2 docs: clarify what `varargs` is all about
> 
>   Documentation/technical/api-trace2.txt | 22 +++++++++++-----------
>   1 file changed, 11 insertions(+), 11 deletions(-)
> 
> 
> base-commit: 1a4874565fa3b6668042216189551b98b4dc0b1b
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1172%2Fdscho%2Ffix-trace2-docs-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1172/dscho/fix-trace2-docs-v1
> Pull-Request: https://github.com/gitgitgadget/git/pull/1172
> 

LGTM

Thanks
Jeff