Skip to content

Commit 2e81873

Browse files
matousc89matousc89
committed
lorem ipsum documentation and tests
1 parent 915bbea commit 2e81873

File tree

8 files changed

+303
-39
lines changed

8 files changed

+303
-39
lines changed

‎.vscode/settings.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"python.linting.enabled": false
3+
}

‎docsdir/source/sources/generators/lorem_ipsum.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. _generators-lorem_ipsum:
2+
3+
Lorem Ipsum
4+
***********************
5+
6+
.. automodule:: signalz.generators.lorem_ipsum
7+
:members:
8+
:show-inheritance:

‎docsdir/source/sources/tags/random.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,10 @@ Random
55

66
This tag covers functions that are using pseudorandom numbers.
77

8-
:ref:`generators-gaussian_white_noise`
9-
10-
:ref:`generators-uniform_white_noise`
11-
128
:ref:`generators-brownian_noise`
139

10+
:ref:`generators-gaussian_white_noise`
11+
1412
:ref:`generators-random_steps`
1513

1614
:ref:`generators-levy_noise`
@@ -19,5 +17,8 @@ This tag covers functions that are using pseudorandom numbers.
1917

2018
:ref:`generators-levy_walk`
2119

20+
:ref:`generators-lorem_ipsum`
21+
22+
:ref:`generators-uniform_white_noise`
2223

2324

‎docsdir/source/sources/tags/text.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. _tags-text:
2+
3+
Text
4+
********************************
5+
6+
This tag covers generators producing text outputs.
7+
8+
:ref:`generators-lorem_ipsum`

‎examples.py

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
import signalz
22

3-
a = signalz.lorem_ipsum.get_sentence()
3+
content = signalz.lorem_ipsum.get_sentence(words=10)
44

5-
print(a)
5+
6+
d = ["mouse", "rat", "shark", "sheep", "cat", "dog"]
7+
content = signalz.lorem_ipsum.get_sentence(dictionary=d)
8+
9+
# content = signalz.lorem_ipsum.get_text()
10+
11+
content = signalz.lorem_ipsum.get_text(words=50, words_per_sentence=4)
12+
13+
content = signalz.lorem_ipsum.get_paragraphs()
14+
15+
16+
content = signalz.lorem_ipsum.get_sentence(dictionary="english")
17+
18+
19+
print(content)

‎signalz/__init__.py

Lines changed: 52 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@
3939
4040
:ref:`tags-autoregressive`
4141
42+
43+
4244
.. cssclass:: funcitem
4345
4446
* :ref:`generators-brownian_noise`
@@ -48,6 +50,7 @@
4850
:ref:`tags-random`, :ref:`tags-noise`
4951
5052
53+
5154
.. cssclass:: funcitem
5255
5356
* :ref:`generators-cosinus`
@@ -57,105 +60,127 @@
5760
:ref:`tags-goniometric`
5861
5962
63+
6064
.. cssclass:: funcitem
6165
62-
* :ref:`generators-gaussian_white_noise`
66+
* :ref:`generators-ecgsyn`
6367
6468
.. cssclass:: functag
6569
66-
:ref:`tags-random`, :ref:`tags-noise`
70+
:ref:`tags-biosignal`
71+
6772
6873
6974
.. cssclass:: funcitem
7075
71-
* :ref:`generators-sinus`
76+
* :ref:`generators-gaussian_white_noise`
7277
7378
.. cssclass:: functag
7479
75-
:ref:`tags-goniometric`
76-
80+
:ref:`tags-random`, :ref:`tags-noise`
7781
7882
83+
7984
.. cssclass:: funcitem
8085
81-
* :ref:`generators-steps`
86+
* :ref:`generators-levy_noise`
8287
8388
.. cssclass:: functag
8489
85-
:ref:`tags-steps`
86-
90+
:ref:`tags-random`, :ref:`tags-noise`
91+
92+
8793
8894
.. cssclass:: funcitem
8995
90-
* :ref:`generators-random_steps`
96+
* :ref:`generators-levy_flight`
9197
9298
.. cssclass:: functag
9399
94-
:ref:`tags-steps`, :ref:`tags-random`
95-
100+
:ref:`tags-random`
101+
102+
96103
97104
.. cssclass:: funcitem
98105
99-
* :ref:`generators-mackey_glass`
106+
* :ref:`generators-levy_walk`
100107
101108
.. cssclass:: functag
102109
103-
:ref:`tags-chaotic`
104-
110+
:ref:`tags-random`
111+
112+
105113
106114
.. cssclass:: funcitem
107115
108-
* :ref:`generators-uniform_white_noise`
116+
* :ref:`generators-logistic_map`
109117
110118
.. cssclass:: functag
111119
112-
:ref:`tags-random`, :ref:`tags-noise`
120+
:ref:`tags-population_model`, :ref:`tags-chaotic`
121+
122+
113123
114-
115124
.. cssclass:: funcitem
116125
117-
* :ref:`generators-levy_noise`
126+
* :ref:`generators-lorem_ipsum`
118127
119128
.. cssclass:: functag
120129
121-
:ref:`tags-random`, :ref:`tags-noise`
130+
:ref:`tags-text`, :ref:`tags-random`
131+
122132
123133
124134
.. cssclass:: funcitem
125135
126-
* :ref:`generators-levy_flight`
136+
* :ref:`generators-mackey_glass`
127137
128138
.. cssclass:: functag
129139
130-
:ref:`tags-random`
140+
:ref:`tags-chaotic`
141+
131142
132143
133144
.. cssclass:: funcitem
134145
135-
* :ref:`generators-levy_walk`
146+
* :ref:`generators-random_steps`
136147
137148
.. cssclass:: functag
138149
139-
:ref:`tags-random`
150+
:ref:`tags-steps`, :ref:`tags-random`
151+
140152
141153
154+
.. cssclass:: funcitem
155+
156+
* :ref:`generators-sinus`
157+
158+
.. cssclass:: functag
159+
160+
:ref:`tags-goniometric`
161+
162+
142163
143164
.. cssclass:: funcitem
144165
145-
* :ref:`generators-logistic_map`
166+
* :ref:`generators-steps`
146167
147168
.. cssclass:: functag
148169
149-
:ref:`tags-population_model`, :ref:`tags-chaotic`
170+
:ref:`tags-steps`
171+
150172
151173
152174
.. cssclass:: funcitem
153175
154-
* :ref:`generators-ecgsyn`
176+
* :ref:`generators-uniform_white_noise`
155177
156178
.. cssclass:: functag
157179
158-
:ref:`tags-biosignal`
180+
:ref:`tags-random`, :ref:`tags-noise`
181+
182+
183+
159184
160185
161186
Contact

0 commit comments

Comments
 (0)