Skip to content

Commit 3154610

Browse files
authored
Merge pull request #139 from djkapner/doc_fix
fixing get_sectionId_for_z documentation
2 parents 8366cfd + 02172e0 commit 3154610

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ addons:
1717
- libopenblas-base
1818
- libopenblas-dev
1919
- gfortran
20-
- oracle-java8-set-default
20+
- oracle-java9-set-default
2121
- maven
2222
install:
2323
- pip install codecov

renderapi/stack.py

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ def delete_section(stack, z, host=None, port=None, owner=None,
331331
----------
332332
stack : str
333333
stack to delete section from
334-
z : float
334+
z : int or float or str
335335
z value to delete
336336
render : renderapi.render.Render
337337
render connect object
@@ -595,7 +595,7 @@ def get_bounds_from_z(stack, z, host=None, port=None, owner=None,
595595
----------
596596
stack : str
597597
stack to get bounds from
598-
z : float
598+
z : int or float or str
599599
z value to get bounds for
600600
render : renderapi.render.Render
601601
render connect object
@@ -651,8 +651,8 @@ def get_stack_bounds(stack, host=None, port=None, owner=None, project=None,
651651

652652
@renderaccess
653653
def get_tilebounds_for_z(stack, z, host=None, port=None, owner=None,
654-
project=None, session=requests.session(),
655-
render=None, **kwargs):
654+
project=None, session=requests.session(),
655+
render=None, **kwargs):
656656
"""returns the bounds for each tile associated with a particular z value
657657
658658
:func:`renderapi.render.renderaccess` decorated function
@@ -661,8 +661,8 @@ def get_tilebounds_for_z(stack, z, host=None, port=None, owner=None,
661661
----------
662662
stack : str
663663
stack to look within
664-
sectionId : str
665-
sectionId to find z value
664+
z : int or float or str
665+
z value for which to get tile bounds
666666
render : renderapi.render.Render
667667
render connect object
668668
session : requests.sessions.Session
@@ -683,6 +683,7 @@ def get_tilebounds_for_z(stack, z, host=None, port=None, owner=None,
683683
host, port, owner, project, stack) + '/z/{}/tileBounds'.format(z)
684684
return get_json(session, request_url)
685685

686+
686687
@renderaccess
687688
def get_sectionId_for_z(stack, z, host=None, port=None, owner=None,
688689
project=None, session=requests.session(),
@@ -695,26 +696,26 @@ def get_sectionId_for_z(stack, z, host=None, port=None, owner=None,
695696
----------
696697
stack : str
697698
stack to look within
698-
sectionId : str
699-
sectionId to find z value
699+
z : int or float or str
700+
section z value
700701
render : renderapi.render.Render
701702
render connect object
702703
session : requests.sessions.Session
703704
session object (default start a new one)
704705
705706
Returns
706707
-------
707-
float
708-
z value of sectionId
708+
str
709+
value of sectionId
709710
710711
Raises
711712
------
712713
RenderError
713714
714715
"""
715-
716716

717-
bounds = get_tilebounds_for_z(stack, z, host, port, owner, project, session)
717+
bounds = get_tilebounds_for_z(
718+
stack, z, host, port, owner, project, session)
718719

719720
try:
720721
return bounds[0]['sectionId']

0 commit comments

Comments
 (0)