Skip to content

Commit a589a9a

Browse files
committed
docs: fix issue with too many new lines
1 parent 80d0207 commit a589a9a

28 files changed

+0
-88
lines changed

docsrc/conf.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515

1616
sys.path.insert(0, os.path.abspath(".."))
1717

18-
1918
# -- Project information -----------------------------------------------------
2019

2120
project = "pyCheckpoint-API"
@@ -25,7 +24,6 @@
2524
# The full version, including alpha/beta/rc tags
2625
release = "1.0.0"
2726

28-
2927
# -- General configuration ---------------------------------------------------
3028

3129
# Add any Sphinx extension module names here, as strings. They can be

examples/objects_export.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,6 @@
131131
+ "s"
132132
)
133133

134-
135134
except restfly.errors.BadRequestError as e:
136135
print(e)
137136
for p in dir(e.response.request):

pycheckpoint_api/firewallManagement/__init__.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ def __init__(self, **kw):
3131
Args:
3232
**kw (dict): Arbitrary keyword arguments for parameters.
3333
34-
3534
Keyword Args:
3635
**user (str, optional)
3736
User name to use to authenticate (instead of ``api_key``)

pycheckpoint_api/firewallManagement/abstract/network_object.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ def show_object(
3838
The level of detail for some of the fields in the response can vary from showing only the UID value\
3939
of the object to a fully detailed representation of the object.
4040
41-
4241
Returns:
4342
:obj:`Box`: The response from the server
4443

pycheckpoint_api/firewallManagement/access_control_nat/__init__.py

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,9 @@ class AccessControlNAT(APIEndpoint):
1212
def access_rule(self) -> AccessRule:
1313
"""The interface object for the objects type "Access Rule" Management.
1414
15-
1615
Returns:
1716
AccessRule: an Access Rule instance
1817
19-
2018
Examples:
2119
>>> firewall.access_control_nat.access_rule
2220
@@ -27,11 +25,9 @@ def access_rule(self) -> AccessRule:
2725
def access_section(self) -> AccessSection:
2826
"""The interface object for the objects type "Access Section" Management.
2927
30-
3128
Returns:
3229
AccessSection: an Access Section instance
3330
34-
3531
Examples:
3632
>>> firewall.access_control_nat.access_section
3733
@@ -42,11 +38,9 @@ def access_section(self) -> AccessSection:
4238
def access_layer(self) -> AccessLayer:
4339
"""The interface object for the objects type "Access Layer" Management.
4440
45-
4641
Returns:
4742
AccessLayer: an Access Layer section
4843
49-
5044
Examples:
5145
>>> firewall.access_control_nat.access_layer
5246
@@ -57,11 +51,9 @@ def access_layer(self) -> AccessLayer:
5751
def nat_rule(self) -> NATRule:
5852
"""The interface object for the objects type "NAT Rule" Management.
5953
60-
6154
Returns:
6255
NATRule: a NAT Rule instance
6356
64-
6557
Examples:
6658
>>> firewall.access_control_nat.nat_rule
6759
@@ -72,11 +64,9 @@ def nat_rule(self) -> NATRule:
7264
def nat_section(self) -> NATSection:
7365
"""The interface object for the objects type "NAT Section" Management.
7466
75-
7667
Returns:
7768
NATSection: a NAT Section instance
7869
79-
8070
Examples:
8171
>>> firewall.access_control_nat.nat_section
8272

pycheckpoint_api/firewallManagement/access_control_nat/access_layer.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,6 @@ def show_access_layers(
312312
limit (int): The maximal number of returned results. Defaults to 50 (between 1 and 500)
313313
offset (int): Number of the results to initially skip. Defaults to 0
314314
315-
316315
Keyword Args:
317316
**details-level (str, optional):
318317
The level of detail for some of the fields in the response can vary from showing only the UID value\

pycheckpoint_api/firewallManagement/access_control_nat/access_section.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ def add(
2727
(see the API documentation).
2828
name (str, optional): Section name.
2929
30-
3130
Keyword Args:
3231
**details-level (str, optional):
3332
The level of detail for some of the fields in the response can vary from showing only the UID value\
@@ -79,7 +78,6 @@ def show(
7978
uid (str, optional): Object unique identifier. Mandatory if "rule_number" or "name" are not set.
8079
name (str, optional): Object name. Mandatory if "rule_number" or "uid" are not set.
8180
82-
8381
Keyword Args:
8482
**details-level (str, optional):
8583
The level of detail for some of the fields in the response can vary from showing only the UID value\
@@ -127,7 +125,6 @@ def set(
127125
new_name (str, optional): New name of the object.
128126
name (str, optional): Rule name.
129127
130-
131128
Keyword Args:
132129
**details-level (str, optional):
133130
The level of detail for some of the fields in the response can vary from showing only the UID value\
@@ -186,7 +183,6 @@ def delete(
186183
uid (str, optional): Object unique identifier.
187184
name (str, optional): Object name.
188185
189-
190186
Keyword Args:
191187
**details-level (str, optional):
192188
The level of detail for some of the fields in the response can vary from showing only the UID value\

pycheckpoint_api/firewallManagement/access_control_nat/nat_rule.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ def add(
4545
translated_service (str, optional): Translated service.
4646
translated_source (str, optional): Translated service.
4747
48-
4948
Keyword Args:
5049
**comments (str, optional):
5150
Comments string.
@@ -129,7 +128,6 @@ def show(
129128
uid (str, optional): Object unique identifier. Mandatory if "rule_number" or "name" are not set.
130129
name (str, optional): Object name. Mandatory if "rule_number" or "uid" are not set.
131130
132-
133131
Keyword Args:
134132
**details-level (str, optional):
135133
The level of detail for some of the fields in the response can vary from showing only the UID value\
@@ -204,7 +202,6 @@ def set(
204202
translated_service (str, optional): Translated service.
205203
translated_source (str, optional): Translated service.
206204
207-
208205
Keyword Args:
209206
**details-level (str, optional):
210207
The level of detail for some of the fields in the response can vary from showing only the UID value\
@@ -368,7 +365,6 @@ def show_nat_rulebase(
368365
package (str, optional): Name of the package.
369366
use_object_dictionnary (bool, optional): N/A
370367
371-
372368
Keyword Args:
373369
**details-level (str, optional):
374370
The level of detail for some of the fields in the response can vary from showing only the UID value\
@@ -380,7 +376,6 @@ def show_nat_rulebase(
380376
**dereference-group-members (bool, optional):
381377
Indicates whether to dereference "members" field by details level for every object in reply.
382378
383-
384379
Returns:
385380
:obj:`Box`: The response from the server
386381

pycheckpoint_api/firewallManagement/access_control_nat/nat_section.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ def add(
2727
(see the API documentation).
2828
name (str, optional): Section name.
2929
30-
3130
Keyword Args:
3231
**details-level (str, optional):
3332
The level of detail for some of the fields in the response can vary from showing only the UID value\
@@ -79,7 +78,6 @@ def show(
7978
uid (str, optional): Object unique identifier. Mandatory if "rule_number" or "name" are not set.
8079
name (str, optional): Object name. Mandatory if "rule_number" or "uid" are not set.
8180
82-
8381
Keyword Args:
8482
**details-level (str, optional):
8583
The level of detail for some of the fields in the response can vary from showing only the UID value\
@@ -127,7 +125,6 @@ def set(
127125
new_name (str, optional): New name of the object.
128126
name (str, optional): Rule name.
129127
130-
131128
Keyword Args:
132129
**details-level (str, optional):
133130
The level of detail for some of the fields in the response can vary from showing only the UID value\

pycheckpoint_api/firewallManagement/exception.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ def __init__(
1313
message (str, optional): Custom string to show when the exception occurs.
1414
... Defaults to "This field has no value provided whereas it's mandatory"
1515
16-
1716
Examples:
1817
>>> raise MandatoryFieldMissing("uid or name")
1918
@@ -43,7 +42,6 @@ def __init__(
4342
message (str, optional): Custom string to show when the exception occurs.
4443
... Defaults to "This value has not the expected type"
4544
46-
4745
Examples:
4846
>>> raise WrongType(value="value1", expected_type=int)
4947

0 commit comments

Comments
 (0)