Skip to content

Commit 5daf8a4

Browse files
committed
Removing keyword "optional" from docstring to be compliant with Numpy Docstring format
1 parent 4755184 commit 5daf8a4

3 files changed

Lines changed: 24 additions & 24 deletions

File tree

‎src/osw/ontology.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,7 @@ def _delete_node(self, id: str, key: str = "@id") -> bool:
412412
the graph (list of nodes) to delete from
413413
id
414414
the id of the node to delete
415-
key, optional
415+
key
416416
the id key, by default '@id'
417417
418418
Returns

‎src/osw/utils/templates.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ def eval_compiled_handlebars_template(
3030
the compiled template
3131
data
3232
the data dictionary
33-
helpers, optional
33+
helpers
3434
helper functions, by default {}
35-
partials, optional
35+
partials
3636
partials, by default {}
37-
add_self_as_partial, optional
37+
add_self_as_partial
3838
if true, add the compiled template as partial 'self', by default True
3939
4040
Returns
@@ -66,11 +66,11 @@ def eval_handlebars_template(
6666
the template string
6767
data
6868
the data dictionary
69-
helpers, optional
69+
helpers
7070
helper functions, by default {}
71-
partials, optional
71+
partials
7272
partials, by default {}
73-
add_self_as_partial, optional
73+
add_self_as_partial
7474
if true, add the compiled template as partial 'self', by default True
7575
7676
Returns

‎src/osw/wtsite.py‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -161,11 +161,11 @@ def from_domain(
161161
162162
Parameters
163163
----------
164-
domain, optional
164+
domain
165165
the wiki domain, by default None
166-
password_file, optional
166+
password_file
167167
password file with credentials for the wiki site, by default None
168-
credentials, optional
168+
credentials
169169
credentials of the wiki site, by default None
170170
171171
Returns
@@ -456,13 +456,13 @@ def modify_search_results(
456456
The search query.
457457
modify_page
458458
The callback that modifies the pages.
459-
limit, optional
459+
limit
460460
query limit, by default None
461-
comment, optional
461+
comment
462462
edit comment, by default None
463-
log, optional
463+
log
464464
log changes, by default False
465-
dryrun, optional
465+
dryrun
466466
if True, no actual changes are made, by default False
467467
"""
468468
titles = []
@@ -1156,11 +1156,11 @@ def __init__(self, wtSite: WtSite = None, title: str = None, do_init: bool = Tru
11561156
11571157
Parameters
11581158
----------
1159-
wtSite, optional
1159+
wtSite
11601160
The instance site object, by default None
1161-
title, optional
1161+
title
11621162
the page title, by default None
1163-
do_init, optional
1163+
do_init
11641164
whether to initialize the page, by default True
11651165
"""
11661166
self.wtSite = wtSite
@@ -1406,9 +1406,9 @@ def append_template(self, template_name: str = None, template_params: dict = Non
14061406
14071407
Parameters
14081408
----------
1409-
template_name, optional
1409+
template_name
14101410
the name of the template, by default None
1411-
template_params, optional
1411+
template_params
14121412
the parameters of the template, by default None
14131413
14141414
Returns
@@ -1483,7 +1483,7 @@ def set_value(self, jsonpath_match, value, replace=False):
14831483
The JSONPath expression
14841484
value
14851485
The value to set
1486-
replace, optional
1486+
replace
14871487
Whether to replace the value, by default False
14881488
14891489
Returns
@@ -1596,7 +1596,7 @@ def delete(self, comment: str = None):
15961596
15971597
Parameters
15981598
----------
1599-
comment, optional
1599+
comment
16001600
The delete comment, by default None
16011601
"""
16021602
self._page.delete(comment)
@@ -1608,9 +1608,9 @@ def move(self, new_title: str, comment: str = None, redirect: bool = True):
16081608
----------
16091609
new_title
16101610
the new title of the page
1611-
comment, optional
1611+
comment
16121612
the edit comment
1613-
redirect, optional
1613+
redirect
16141614
whether to create a redirect from the old title to the new title
16151615
"""
16161616
if new_title != self.title:
@@ -1912,7 +1912,7 @@ def export_xml(self, config: Optional[ExportConfig] = None) -> ExportResult:
19121912
19131913
Parameters
19141914
----------
1915-
config, optional
1915+
config
19161916
see ExportConfig
19171917
19181918
Returns

0 commit comments

Comments
 (0)