Offset 1, 3 lines modified | Offset 1, 3 lines modified | ||
1 | · | 1 | ·1af80c28532177b502eee204d7aa1122·333116·doc·optional·python-cloup-doc_3.0.5-1_all.deb |
2 | ·f0d9f7fc4a39f35d10650507ef065ff6·47132·python·optional·python3-cloup_3.0.5-1_all.deb | 2 | ·f0d9f7fc4a39f35d10650507ef065ff6·47132·python·optional·python3-cloup_3.0.5-1_all.deb |
Offset 245, 16 lines modified | Offset 245, 16 lines modified | ||
245 | to·them·by·name.</p> | 245 | to·them·by·name.</p> |
246 | </div></blockquote> | 246 | </div></blockquote> |
247 | <p>Cloup·doesn’t·force·the·Unix·convention·on·you.·<code·class="docutils·literal·notranslate"><span·class="pre">cloup.argument</span></code>·takes·an | 247 | <p>Cloup·doesn’t·force·the·Unix·convention·on·you.·<code·class="docutils·literal·notranslate"><span·class="pre">cloup.argument</span></code>·takes·an |
248 | optional·<code·class="docutils·literal·notranslate"><span·class="pre">help</span></code>·parameter.·If·you·pass·a·non-empty·string·to·at·least·one·of | 248 | optional·<code·class="docutils·literal·notranslate"><span·class="pre">help</span></code>·parameter.·If·you·pass·a·non-empty·string·to·at·least·one·of |
249 | the·arguments·of·a·command,·Cloup·will·print·a·“Positional·arguments”·section | 249 | the·arguments·of·a·command,·Cloup·will·print·a·“Positional·arguments”·section |
250 | just·below·the·command·description.</p> | 250 | just·below·the·command·description.</p> |
251 | <div·class="tabbed-set·docutils"> | 251 | <div·class="tabbed-set·docutils"> |
252 | <input·checked="checked"·id="297d9d5f-9db8-4926-b254-36256e00d042"·name="7bc3a560-ce0f-4e90-8832-de9dd6b35229"·type="radio"> | ||
253 | < | 252 | <input·checked="checked"·id="8d28984e-7a59-4387-b0cd-8dea14da98be"·name="d58f2d26-7771-4e28-8d10-04a3cc284828"·type="radio"> |
253 | </input><label·class="tabbed-label"·for="8d28984e-7a59-4387-b0cd-8dea14da98be"> | ||
254 | Code</label><div·class="tabbed-content·docutils"> | 254 | Code</label><div·class="tabbed-content·docutils"> |
255 | <div·class="highlight-python·notranslate"><div·class="highlight"><pre><span></span><span·class="kn">from</span>·<span·class="nn">pprint</span>·<span·class="kn">import</span>·<span·class="n">pprint</span> | 255 | <div·class="highlight-python·notranslate"><div·class="highlight"><pre><span></span><span·class="kn">from</span>·<span·class="nn">pprint</span>·<span·class="kn">import</span>·<span·class="n">pprint</span> |
256 | <span·class="kn">import</span>·<span·class="nn">cloup</span> | 256 | <span·class="kn">import</span>·<span·class="nn">cloup</span> |
257 | <span·class="kn">from</span>·<span·class="nn">cloup</span>·<span·class="kn">import</span>·<span·class="n">option</span><span·class="p">,</span>·<span·class="n">option_group</span> | 257 | <span·class="kn">from</span>·<span·class="nn">cloup</span>·<span·class="kn">import</span>·<span·class="n">option</span><span·class="p">,</span>·<span·class="n">option_group</span> |
258 | <span·class="nd">@cloup</span><span·class="o">.</span><span·class="n">command</span><span·class="p">()</span> | 258 | <span·class="nd">@cloup</span><span·class="o">.</span><span·class="n">command</span><span·class="p">()</span> |
259 | <span·class="nd">@cloup</span><span·class="o">.</span><span·class="n">argument</span><span·class="p">(</span><span·class="s1">'input_path'</span><span·class="p">,</span>·<span·class="n">help</span><span·class="o">=</span><span·class="s2">"Input·path"</span><span·class="p">)</span> | 259 | <span·class="nd">@cloup</span><span·class="o">.</span><span·class="n">argument</span><span·class="p">(</span><span·class="s1">'input_path'</span><span·class="p">,</span>·<span·class="n">help</span><span·class="o">=</span><span·class="s2">"Input·path"</span><span·class="p">)</span> |
Offset 466, 16 lines modified | Offset 466, 16 lines modified | ||
466 | <li><p>the·option·description·is·always·printed·below·the·option·name,·with·an·indentation | 466 | <li><p>the·option·description·is·always·printed·below·the·option·name,·with·an·indentation |
467 | increment·of·at·least·3·spaces</p></li> | 467 | increment·of·at·least·3·spaces</p></li> |
468 | <li><p>all·definitions·are·separated·by·an·empty·line.</p></li> | 468 | <li><p>all·definitions·are·separated·by·an·empty·line.</p></li> |
469 | </ul> | 469 | </ul> |
470 | <p>The·following·tabs·compare·the·<code·class="docutils·literal·notranslate"><span·class="pre">--help</span></code>·of·the·manim·example·(“aligned”·and | 470 | <p>The·following·tabs·compare·the·<code·class="docutils·literal·notranslate"><span·class="pre">--help</span></code>·of·the·manim·example·(“aligned”·and |
471 | “non-aligned”·refer·to·the·<code·class="docutils·literal·notranslate"><span·class="pre">align_option_groups</span></code>·argument):</p> | 471 | “non-aligned”·refer·to·the·<code·class="docutils·literal·notranslate"><span·class="pre">align_option_groups</span></code>·argument):</p> |
472 | <div·class="tabbed-set·docutils"> | 472 | <div·class="tabbed-set·docutils"> |
473 | <input·checked="checked"·id="fc9e4f80-450c-4769-bdac-7ea50299edeb"·name="87a0ae75-bea5-4d8f-a81d-a8f849edb6b9"·type="radio"> | ||
474 | < | 473 | <input·checked="checked"·id="812a6c52-7fbc-42a9-92dd-ee4d48ac57e5"·name="66263fab-bf39-4675-97c4-f75b8606f9e0"·type="radio"> |
474 | </input><label·class="tabbed-label"·for="812a6c52-7fbc-42a9-92dd-ee4d48ac57e5"> | ||
475 | Linear·layout</label><div·class="tabbed-content·docutils"> | 475 | Linear·layout</label><div·class="tabbed-content·docutils"> |
476 | <div·class="highlight-none·notranslate"><div·class="highlight"><pre><span></span>Usage:·manim·render·[OPTIONS] | 476 | <div·class="highlight-none·notranslate"><div·class="highlight"><pre><span></span>Usage:·manim·render·[OPTIONS] |
477 | ····················SCRIPT_PATH | 477 | ····················SCRIPT_PATH |
478 | ····················[SCENE_NAMES]... | 478 | ····················[SCENE_NAMES]... |
479 | ··Render·some·or·all·scenes·defined·in·a·Python | 479 | ··Render·some·or·all·scenes·defined·in·a·Python |
480 | ··script. | 480 | ··script. |
Offset 265, 16 lines modified | Offset 265, 16 lines modified | ||
265 | a·description·of·the·constraint·will·be·shown·between·squared·brackets | 265 | a·description·of·the·constraint·will·be·shown·between·squared·brackets |
266 | aside·the·option·group·title·(or·below·it·if·too·long)</p></li> | 266 | aside·the·option·group·title·(or·below·it·if·too·long)</p></li> |
267 | <li><p><strong>hidden</strong>·– | 267 | <li><p><strong>hidden</strong>·– |
268 | if·True,·the·option·group·and·all·its·options·are·hidden·from·the·help·page | 268 | if·True,·the·option·group·and·all·its·options·are·hidden·from·the·help·page |
269 | (all·contained·options·will·have·their·hidden·attribute·set·to·True).</p></li> | 269 | (all·contained·options·will·have·their·hidden·attribute·set·to·True).</p></li> |
270 | </ul> | 270 | </ul> |
271 | <div·class="tabbed-set·docutils"> | 271 | <div·class="tabbed-set·docutils"> |
272 | <input·checked="checked"·id="3f5fcc16-ffd3-467a-b342-5797bc2775e8"·name="8159dd96-f61d-4405-918f-2b11f52bc613"·type="radio"> | ||
273 | < | 272 | <input·checked="checked"·id="8c057d6e-4cff-4fd7-9006-9796225c3957"·name="5e353a4f-fd93-46d8-a3f8-7d51320896f5"·type="radio"> |
273 | </input><label·class="tabbed-label"·for="8c057d6e-4cff-4fd7-9006-9796225c3957"> | ||
274 | Code</label><div·class="tabbed-content·docutils"> | 274 | Code</label><div·class="tabbed-content·docutils"> |
275 | <div·class="highlight-python·notranslate"><div·class="highlight"><pre><span></span><span·class="kn">import</span>·<span·class="nn">cloup</span> | 275 | <div·class="highlight-python·notranslate"><div·class="highlight"><pre><span></span><span·class="kn">import</span>·<span·class="nn">cloup</span> |
276 | <span·class="kn">from</span>·<span·class="nn">cloup</span>·<span·class="kn">import</span>·<span·class="n">option_group</span><span·class="p">,</span>·<span·class="n">option</span> | 276 | <span·class="kn">from</span>·<span·class="nn">cloup</span>·<span·class="kn">import</span>·<span·class="n">option_group</span><span·class="p">,</span>·<span·class="n">option</span> |
277 | <span·class="kn">from</span>·<span·class="nn">cloup.constraints</span>·<span·class="kn">import</span>·<span·class="n">RequireAtLeast</span> | 277 | <span·class="kn">from</span>·<span·class="nn">cloup.constraints</span>·<span·class="kn">import</span>·<span·class="n">RequireAtLeast</span> |
278 | <span·class="nd">@cloup</span><span·class="o">.</span><span·class="n">command</span><span·class="p">()</span> | 278 | <span·class="nd">@cloup</span><span·class="o">.</span><span·class="n">command</span><span·class="p">()</span> |
279 | <span·class="nd">@option_group</span><span·class="p">(</span> | 279 | <span·class="nd">@option_group</span><span·class="p">(</span> |
Offset 252, 16 lines modified | Offset 252, 16 lines modified | ||
252 | <section·id="adding-full-sections"> | 252 | <section·id="adding-full-sections"> |
253 | <h2>Adding·full·sections<a·class="headerlink"·href="#adding-full-sections"·title="Link·to·this·heading">#</a></h2> | 253 | <h2>Adding·full·sections<a·class="headerlink"·href="#adding-full-sections"·title="Link·to·this·heading">#</a></h2> |
254 | <p>This·is·my·favourite·way·of·structuring·my·sections. | 254 | <p>This·is·my·favourite·way·of·structuring·my·sections. |
255 | You·can·find·a·runnable·example·that·implements·part·of·the·help·of·Git | 255 | You·can·find·a·runnable·example·that·implements·part·of·the·help·of·Git |
256 | <a·class="reference·external"·href="https://github.com/janLuke/cloup/blob/master/examples/git_sections.py">here</a>. | 256 | <a·class="reference·external"·href="https://github.com/janLuke/cloup/blob/master/examples/git_sections.py">here</a>. |
257 | The·code·below·is·based·on·that·example.</p> | 257 | The·code·below·is·based·on·that·example.</p> |
258 | <div·class="tabbed-set·docutils"> | 258 | <div·class="tabbed-set·docutils"> |
259 | <input·checked="checked"·id="03fa201e-4906-4734-b48f-af956e973a86"·name="1bb2a1be-d337-4ab0-9486-97064f724e9b"·type="radio"> | ||
260 | < | 259 | <input·checked="checked"·id="4f24eda3-2acb-43f9-9bcb-89d0fcd80108"·name="ee87dd53-bf4d-42fb-83fd-bc9e2a74fd71"·type="radio"> |
260 | </input><label·class="tabbed-label"·for="4f24eda3-2acb-43f9-9bcb-89d0fcd80108"> | ||
261 | Code</label><div·class="tabbed-content·docutils"> | 261 | Code</label><div·class="tabbed-content·docutils"> |
262 | <div·class="highlight-python·notranslate"><div·class="highlight"><pre><span></span><span·class="kn">import</span>·<span·class="nn">cloup</span> | 262 | <div·class="highlight-python·notranslate"><div·class="highlight"><pre><span></span><span·class="kn">import</span>·<span·class="nn">cloup</span> |
263 | <span·class="kn">from</span>·<span·class="nn">.commands</span>·<span·class="kn">import</span>·<span·class="p">(</span>··<span·class="c1">#·import·your·subcommands</span> | 263 | <span·class="kn">from</span>·<span·class="nn">.commands</span>·<span·class="kn">import</span>·<span·class="p">(</span>··<span·class="c1">#·import·your·subcommands</span> |
264 | ····<span·class="n">git_clone</span><span·class="p">,</span>·<span·class="n">git_init</span><span·class="p">,</span>·<span·class="n">git_rm</span><span·class="p">,</span>·<span·class="n">git_sparse_checkout</span><span·class="p">,</span>·<span·class="n">git_mv</span><span·class="p">,</span> | 264 | ····<span·class="n">git_clone</span><span·class="p">,</span>·<span·class="n">git_init</span><span·class="p">,</span>·<span·class="n">git_rm</span><span·class="p">,</span>·<span·class="n">git_sparse_checkout</span><span·class="p">,</span>·<span·class="n">git_mv</span><span·class="p">,</span> |
265 | ····<span·class="n">git_status</span><span·class="p">,</span>·<span·class="n">git_log</span><span·class="p">)</span> | 265 | ····<span·class="n">git_status</span><span·class="p">,</span>·<span·class="n">git_log</span><span·class="p">)</span> |
266 | <span·class="nd">@cloup</span><span·class="o">.</span><span·class="n">group</span><span·class="p">(</span><span·class="s1">'git'</span><span·class="p">)</span> | 266 | <span·class="nd">@cloup</span><span·class="o">.</span><span·class="n">group</span><span·class="p">(</span><span·class="s1">'git'</span><span·class="p">)</span> |