Skip to content

Commit

Permalink
Fix docs typo
Browse files Browse the repository at this point in the history
  • Loading branch information
biosafetylvl5 committed Aug 9, 2024
1 parent 8cdfdbe commit 6051a20
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ <h1>API<a class="headerlink" href="#api" title="Link to this heading">¶</a></h1
<h2>CLI Arguments<a class="headerlink" href="#cli-arguments" title="Link to this heading"></a></h2>
<p><p>Generate release notes from YAML files. Entries are sorted by order in yaml files, and by order of yaml files provided via the command line.</p>
</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>[38;5;208mUsage:[0m [38;5;244msphinx-build[0m [[36m-h[0m] [[36m-t[0m [38;5;36m[WRITE_YAML_TEMPLATE][0m] [[36m-c[0m [38;5;36m[GET_CHANGED_FILES][0m] [[36m-r[0m [38;5;36mVERSION[0m] [[36m-d[0m [38;5;36mRELEASE_DATE[0m] [[36m-nc[0m] [[36m-p[0m [38;5;36mPREFIX_FILE[0m] [[36m-s[0m [38;5;36mSUFFIX_FILE[0m]
[[36m-o[0m [38;5;36mOUTPUT_FILE[0m] [[36m--output-to-console[0m] [[36m-nr[0m] [[36m-q[0m]
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>[38;5;208mUsage:[0m [38;5;244msphinx-build[0m [[36m-h[0m] [[36m-t[0m [38;5;36m[WRITE_YAML_TEMPLATE][0m] [[36m-c[0m [38;5;36m[GET_CHANGED_FILES][0m] [[36m-r[0m [38;5;36mVERSION[0m] [[36m-d[0m [38;5;36mRELEASE_DATE[0m] [[36m-nc[0m] [[36m-p[0m [38;5;36mPREFIX_FILE[0m] [[36m-s[0m [38;5;36mSUFFIX_FILE[0m] [[36m-o[0m [38;5;36mOUTPUT_FILE[0m]
[[36m--output-to-console[0m] [[36m-nr[0m] [[36m-q[0m]
[input_files_or_folders ...]
</pre></div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ <h2>Generate release notes<a class="headerlink" href="#generate-release-notes" t
<p>For example, if release-note.yaml contains the following:</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">bug-fix</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">title</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Fixed</span><span class="nv"> </span><span class="s">a</span><span class="nv"> </span><span class="s">bug&quot;</span>
<span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;This</span><span class="nv"> </span><span class="s">bug</span><span class="nv"> </span><span class="s">was</span><span class="nv"> </span><span class="s">really</span><span class="nv"> </span><span class="s">annoying&quot;</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;This</span><span class="nv"> </span><span class="s">bug</span><span class="nv"> </span><span class="s">was</span><span class="nv"> </span><span class="s">really</span><span class="nv"> </span><span class="s">annoying&quot;</span>
<span class="w"> </span><span class="nt">files</span><span class="p">:</span>
<span class="w"> </span><span class="nt">modified</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;test.py&quot;</span>
<span class="w"> </span><span class="nt">added</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;old/test.py&quot;</span>
Expand Down
2 changes: 1 addition & 1 deletion sphinx/source/examples/basic-usage/release-note.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
bug-fix:
- title: "Fixed a bug"
description: "This bug was really annoying"
- description: "This bug was really annoying"
files:
modified: "test.py"
added: "old/test.py"

0 comments on commit 6051a20

Please sign in to comment.