Skip to content

Commit 6ba31d8

Browse files
committed
fix typo ("All methods are static")
1 parent a9adbc8 commit 6ba31d8

28 files changed

+57
-57
lines changed

_litgen_template

docs/litgen_book/01_05_05_online.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -615,7 +615,7 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
615615
616616
# <submodule my_math>
617617
class my_math: # Proxy class that introduces typings for the *submodule* my_math
618-
pass # (This corresponds to a C++ namespace. All method are static!)
618+
pass # (This corresponds to a C++ namespace. All methods are static!)
619619
"""This namespace is not ignored and introduces a new python module"""
620620
# div and mul: divide or multiply float numbers
621621
# (This comment concerns the two grouped
@@ -759,7 +759,7 @@ <h1>Use litgen online<a class="headerlink" href="#use-litgen-online" title="Perm
759759

760760
<span class="c1"># &lt;submodule my_math&gt;</span>
761761
<span class="k">class</span> <span class="nc">my_math</span><span class="p">:</span> <span class="c1"># Proxy class that introduces typings for the *submodule* my_math</span>
762-
<span class="k">pass</span> <span class="c1"># (This corresponds to a C++ namespace. All method are static!)</span>
762+
<span class="k">pass</span> <span class="c1"># (This corresponds to a C++ namespace. All methods are static!)</span>
763763
<span class="w"> </span><span class="sd">&quot;&quot;&quot;This namespace is not ignored and introduces a new python module&quot;&quot;&quot;</span>
764764
<span class="c1"># div and mul: divide or multiply float numbers</span>
765765
<span class="c1"># (This comment concerns the two grouped</span>

docs/litgen_book/04_05_00_names_translation.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2158,7 +2158,7 @@ <h2>Convert to snake case<a class="headerlink" href="#convert-to-snake-case" tit
21582158
21592159
# <submodule my_namespace>
21602160
class my_namespace: # Proxy class that introduces typings for the *submodule* my_namespace
2161-
pass # (This corresponds to a C++ namespace. All method are static!)
2161+
pass # (This corresponds to a C++ namespace. All methods are static!)
21622162
class MyClass:
21632163
def add_number(self, a: int, b: int) -> int:
21642164
pass
@@ -2250,7 +2250,7 @@ <h2>Convert to snake case<a class="headerlink" href="#convert-to-snake-case" tit
22502250
.highlight .vm { color: #076678 } /* Name.Variable.Magic */
22512251
.highlight .il { color: #8f3f71 } /* Literal.Number.Integer.Long */</style> <div class="highlight"><pre><span></span><span class="c1"># &lt;submodule my_namespace&gt;</span>
22522252
<span class="k">class</span> <span class="nc">my_namespace</span><span class="p">:</span> <span class="c1"># Proxy class that introduces typings for the *submodule* my_namespace</span>
2253-
<span class="k">pass</span> <span class="c1"># (This corresponds to a C++ namespace. All method are static!)</span>
2253+
<span class="k">pass</span> <span class="c1"># (This corresponds to a C++ namespace. All methods are static!)</span>
22542254
<span class="k">class</span> <span class="nc">MyClass</span><span class="p">:</span>
22552255
<span class="k">def</span> <span class="nf">add_number</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">a</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">b</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
22562256
<span class="k">pass</span>
@@ -2942,7 +2942,7 @@ <h2>Convert to snake case<a class="headerlink" href="#convert-to-snake-case" tit
29422942
29432943
# <submodule MyNamespace>
29442944
class MyNamespace: # Proxy class that introduces typings for the *submodule* MyNamespace
2945-
pass # (This corresponds to a C++ namespace. All method are static!)
2945+
pass # (This corresponds to a C++ namespace. All methods are static!)
29462946
class MyClass:
29472947
def AddNumber(self, a: int, b: int) -> int:
29482948
pass
@@ -3034,7 +3034,7 @@ <h2>Convert to snake case<a class="headerlink" href="#convert-to-snake-case" tit
30343034
.highlight .vm { color: #076678 } /* Name.Variable.Magic */
30353035
.highlight .il { color: #8f3f71 } /* Literal.Number.Integer.Long */</style> <div class="highlight"><pre><span></span><span class="c1"># &lt;submodule MyNamespace&gt;</span>
30363036
<span class="k">class</span> <span class="nc">MyNamespace</span><span class="p">:</span> <span class="c1"># Proxy class that introduces typings for the *submodule* MyNamespace</span>
3037-
<span class="k">pass</span> <span class="c1"># (This corresponds to a C++ namespace. All method are static!)</span>
3037+
<span class="k">pass</span> <span class="c1"># (This corresponds to a C++ namespace. All methods are static!)</span>
30383038
<span class="k">class</span> <span class="nc">MyClass</span><span class="p">:</span>
30393039
<span class="k">def</span> <span class="nf">AddNumber</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">a</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">b</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
30403040
<span class="k">pass</span>

docs/litgen_book/05_05_00_functions.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12093,7 +12093,7 @@ <h2>Vectorize functions<a class="headerlink" href="#vectorize-functions" title="
1209312093

1209412094
# <submodule math_functions>
1209512095
class math_functions: # Proxy class that introduces typings for the *submodule* math_functions
12096-
pass # (This corresponds to a C++ namespace. All method are static!)
12096+
pass # (This corresponds to a C++ namespace. All methods are static!)
1209712097
@staticmethod
1209812098
def fn1(x: float, y: float) -> float:
1209912099
pass
@@ -12189,7 +12189,7 @@ <h2>Vectorize functions<a class="headerlink" href="#vectorize-functions" title="
1218912189
.highlight .vm { color: #076678 } /* Name.Variable.Magic */
1219012190
.highlight .il { color: #8f3f71 } /* Literal.Number.Integer.Long */</style> <div class="highlight"><pre><span></span><span class="c1"># &lt;submodule math_functions&gt;</span>
1219112191
<span class="k">class</span> <span class="nc">math_functions</span><span class="p">:</span> <span class="c1"># Proxy class that introduces typings for the *submodule* math_functions</span>
12192-
<span class="k">pass</span> <span class="c1"># (This corresponds to a C++ namespace. All method are static!)</span>
12192+
<span class="k">pass</span> <span class="c1"># (This corresponds to a C++ namespace. All methods are static!)</span>
1219312193
<span class="nd">@staticmethod</span>
1219412194
<span class="k">def</span> <span class="nf">fn1</span><span class="p">(</span><span class="n">x</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> <span class="n">y</span><span class="p">:</span> <span class="nb">float</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
1219512195
<span class="k">pass</span>

docs/litgen_book/08_05_00_namespaces.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -828,7 +828,7 @@ <h1>Namespaces<a class="headerlink" href="#namespaces" title="Permalink to this
828828
829829
# <submodule inner>
830830
class inner: # Proxy class that introduces typings for the *submodule* inner
831-
pass # (This corresponds to a C++ namespace. All method are static!)
831+
pass # (This corresponds to a C++ namespace. All methods are static!)
832832
""" this is an inner namespace (this comment should become the namespace doc)"""
833833
@staticmethod
834834
def foo_inner() -> None:
@@ -928,7 +928,7 @@ <h1>Namespaces<a class="headerlink" href="#namespaces" title="Permalink to this
928928

929929
<span class="c1"># &lt;submodule inner&gt;</span>
930930
<span class="k">class</span> <span class="nc">inner</span><span class="p">:</span> <span class="c1"># Proxy class that introduces typings for the *submodule* inner</span>
931-
<span class="k">pass</span> <span class="c1"># (This corresponds to a C++ namespace. All method are static!)</span>
931+
<span class="k">pass</span> <span class="c1"># (This corresponds to a C++ namespace. All methods are static!)</span>
932932
<span class="w"> </span><span class="sd">&quot;&quot;&quot; this is an inner namespace (this comment should become the namespace doc)&quot;&quot;&quot;</span>
933933
<span class="nd">@staticmethod</span>
934934
<span class="k">def</span> <span class="nf">foo_inner</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>

docs/litgen_book/08_10_00_custom_bindings.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -896,7 +896,7 @@ <h2>Generated code (with custom bindings)<a class="headerlink" href="#generated-
896896
897897
# <submodule root_ns>
898898
class root_ns: # Proxy class that introduces typings for the *submodule* root_ns
899-
pass # (This corresponds to a C++ namespace. All method are static!)
899+
pass # (This corresponds to a C++ namespace. All methods are static!)
900900
class Foo:
901901
m_value: int = 0
902902
def __init__(self, m_value: int = 0) -> None:
@@ -1001,7 +1001,7 @@ <h2>Generated code (with custom bindings)<a class="headerlink" href="#generated-
10011001
.highlight .vm { color: #076678 } /* Name.Variable.Magic */
10021002
.highlight .il { color: #8f3f71 } /* Literal.Number.Integer.Long */</style> <div class="highlight"><pre><span></span><span class="c1"># &lt;submodule root_ns&gt;</span>
10031003
<span class="k">class</span> <span class="nc">root_ns</span><span class="p">:</span> <span class="c1"># Proxy class that introduces typings for the *submodule* root_ns</span>
1004-
<span class="k">pass</span> <span class="c1"># (This corresponds to a C++ namespace. All method are static!)</span>
1004+
<span class="k">pass</span> <span class="c1"># (This corresponds to a C++ namespace. All methods are static!)</span>
10051005
<span class="k">class</span> <span class="nc">Foo</span><span class="p">:</span>
10061006
<span class="n">m_value</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span>
10071007
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">m_value</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>

src/litgen/integration_tests/_stubs/lg_mylib/__init__.pyi

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -967,7 +967,7 @@ def fn_brace(
967967

968968
# <submodule math_functions>
969969
class math_functions: # Proxy class that introduces typings for the *submodule* math_functions
970-
pass # (This corresponds to a C++ namespace. All method are static!)
970+
pass # (This corresponds to a C++ namespace. All methods are static!)
971971
""" Vectorizable functions example
972972
Numeric functions (i.e. function accepting and returning only numeric params or py::array), can be vectorized
973973
i.e. they will accept numpy arrays as an input.
@@ -990,7 +990,7 @@ class math_functions: # Proxy class that introduces typings for the *submodule*
990990

991991
# <submodule animals>
992992
class animals: # Proxy class that introduces typings for the *submodule* animals
993-
pass # (This corresponds to a C++ namespace. All method are static!)
993+
pass # (This corresponds to a C++ namespace. All methods are static!)
994994

995995
class Animal:
996996
def __init__(self, name: str) -> None:
@@ -1007,7 +1007,7 @@ class animals: # Proxy class that introduces typings for the *submodule* animal
10071007

10081008
# <submodule home>
10091009
class home: # Proxy class that introduces typings for the *submodule* home
1010-
pass # (This corresponds to a C++ namespace. All method are static!)
1010+
pass # (This corresponds to a C++ namespace. All methods are static!)
10111011

10121012
class Pet:
10131013
def is_pet(self) -> bool:
@@ -1026,7 +1026,7 @@ class home: # Proxy class that introduces typings for the *submodule* home
10261026

10271027
# <submodule aaa>
10281028
class aaa: # Proxy class that introduces typings for the *submodule* aaa
1029-
pass # (This corresponds to a C++ namespace. All method are static!)
1029+
pass # (This corresponds to a C++ namespace. All methods are static!)
10301030

10311031
# ------------------------------------------------------------------------
10321032
# <template specializations for class Copyable_Template>
@@ -1042,11 +1042,11 @@ class aaa: # Proxy class that introduces typings for the *submodule* aaa
10421042

10431043
# <submodule root>
10441044
class root: # Proxy class that introduces typings for the *submodule* root
1045-
pass # (This corresponds to a C++ namespace. All method are static!)
1045+
pass # (This corresponds to a C++ namespace. All methods are static!)
10461046

10471047
# <submodule inner>
10481048
class inner: # Proxy class that introduces typings for the *submodule* inner
1049-
pass # (This corresponds to a C++ namespace. All method are static!)
1049+
pass # (This corresponds to a C++ namespace. All methods are static!)
10501050

10511051
class MyVirtualClass:
10521052
def foo_concrete(self, x: int, name: str) -> str:
@@ -1082,7 +1082,7 @@ class root: # Proxy class that introduces typings for the *submodule* root
10821082

10831083
# <submodule some_namespace>
10841084
class some_namespace: # Proxy class that introduces typings for the *submodule* some_namespace
1085-
pass # (This corresponds to a C++ namespace. All method are static!)
1085+
pass # (This corresponds to a C++ namespace. All methods are static!)
10861086
""" namespace SomeNamespace"""
10871087

10881088
class ParentStruct:
@@ -1141,7 +1141,7 @@ class some_namespace: # Proxy class that introduces typings for the *submodule*
11411141

11421142
# <submodule some_inner_namespace>
11431143
class some_inner_namespace: # Proxy class that introduces typings for the *submodule* some_inner_namespace
1144-
pass # (This corresponds to a C++ namespace. All method are static!)
1144+
pass # (This corresponds to a C++ namespace. All methods are static!)
11451145
""" namespace SomeInnerNamespace"""
11461146
@staticmethod
11471147
def toggle_bool_pointer(v: BoxedBool) -> None:
@@ -1178,7 +1178,7 @@ class some_namespace: # Proxy class that introduces typings for the *submodule*
11781178

11791179
# <submodule inner>
11801180
class inner: # Proxy class that introduces typings for the *submodule* inner
1181-
pass # (This corresponds to a C++ namespace. All method are static!)
1181+
pass # (This corresponds to a C++ namespace. All methods are static!)
11821182
""" this is an inner namespace (this comment should become the namespace doc)"""
11831183
@staticmethod
11841184
def foo_inner() -> int:
@@ -1191,7 +1191,7 @@ class inner: # Proxy class that introduces typings for the *submodule* inner
11911191

11921192
# <submodule n>
11931193
class n: # Proxy class that introduces typings for the *submodule* n
1194-
pass # (This corresponds to a C++ namespace. All method are static!)
1194+
pass # (This corresponds to a C++ namespace. All methods are static!)
11951195

11961196
class S:
11971197
def __init__(self) -> None:
@@ -1220,7 +1220,7 @@ class n: # Proxy class that introduces typings for the *submodule* n
12201220

12211221
# <submodule a>
12221222
class a: # Proxy class that introduces typings for the *submodule* a
1223-
pass # (This corresponds to a C++ namespace. All method are static!)
1223+
pass # (This corresponds to a C++ namespace. All methods are static!)
12241224

12251225
class Foo(enum.IntEnum):
12261226
foo1 = enum.auto() # (= 0)
@@ -1245,7 +1245,7 @@ class a: # Proxy class that introduces typings for the *submodule* a
12451245

12461246
# <submodule n>
12471247
class n: # Proxy class that introduces typings for the *submodule* n
1248-
pass # (This corresponds to a C++ namespace. All method are static!)
1248+
pass # (This corresponds to a C++ namespace. All methods are static!)
12491249

12501250
class S:
12511251
def __init__(self) -> None:
@@ -1275,7 +1275,7 @@ class a: # Proxy class that introduces typings for the *submodule* a
12751275

12761276
# <submodule root_custom>
12771277
class root_custom: # Proxy class that introduces typings for the *submodule* root_custom
1278-
pass # (This corresponds to a C++ namespace. All method are static!)
1278+
pass # (This corresponds to a C++ namespace. All methods are static!)
12791279

12801280
class Foo:
12811281
m_value: int = 0

src/litgen/integration_tests/mylib/basic_test.h.pyi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def my_mul(a: int, b: int) -> int:
3030

3131
# <submodule math_functions>
3232
class math_functions: # Proxy class that introduces typings for the *submodule* math_functions
33-
pass # (This corresponds to a C++ namespace. All method are static!)
33+
pass # (This corresponds to a C++ namespace. All methods are static!)
3434
""" Vectorizable functions example
3535
Numeric functions (i.e. function accepting and returning only numeric params or py::array), can be vectorized
3636
i.e. they will accept numpy arrays as an input.

src/litgen/integration_tests/mylib/class_copy_test.h.pyi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ class Copyable_DeletedCopyCtor:
4141

4242
# <submodule aaa>
4343
class aaa: # Proxy class that introduces typings for the *submodule* aaa
44-
pass # (This corresponds to a C++ namespace. All method are static!)
44+
pass # (This corresponds to a C++ namespace. All methods are static!)
4545

4646
# ------------------------------------------------------------------------
4747
# <template specializations for class Copyable_Template>

src/litgen/integration_tests/mylib/class_default_ctor_test.h.pyi

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ from typing import overload
1717

1818
# <submodule a>
1919
class a: # Proxy class that introduces typings for the *submodule* a
20-
pass # (This corresponds to a C++ namespace. All method are static!)
20+
pass # (This corresponds to a C++ namespace. All methods are static!)
2121

2222
class Foo(enum.IntEnum):
2323
foo1 = enum.auto() # (= 0)
@@ -42,7 +42,7 @@ class a: # Proxy class that introduces typings for the *submodule* a
4242

4343
# <submodule n>
4444
class n: # Proxy class that introduces typings for the *submodule* n
45-
pass # (This corresponds to a C++ namespace. All method are static!)
45+
pass # (This corresponds to a C++ namespace. All methods are static!)
4646

4747
class S:
4848
def __init__(self) -> None:

0 commit comments

Comments
 (0)