Update doc strings #307

pem70 · 2024-07-08T19:16:03Z

What It Does
Update doc strings for all functions as required by [#279]

How to Test

Review Checklist
I certify that I have:

tested my changes
added/updated automated tests
updated the changelog
followed the contribution guidelines

Additional Comments

Signed-off-by: pem70 <[email protected]>

codecov · 2024-07-08T19:19:27Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.90%. Comparing base (19297ff) to head (a2bcf84).
Report is 146 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #307   +/-   ##
=======================================
  Coverage   89.90%   89.90%           
=======================================
  Files          53       53           
  Lines        2713     2713           
=======================================
  Hits         2439     2439           
  Misses        274      274

Flag	Coverage Δ
unittests	`89.90% <100.00%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

zFernand0 · 2024-07-10T16:44:21Z

Hey @anaxceron,
Here is the live site with the changed that are in the main branch.
https://zowe-client-python-sdk.readthedocs.io/

~~We don't have the equivalent of Netlify for PR builds yet 😢~~
~~But hopefully it helps. 😋~~

UPDATE:

We do have builds for every PR 😋
https://zowe-client-python-sdk--307.org.readthedocs.build/en/307/

Thanks to @t1m0thyj for helping me find this! 🙏🏽

t1m0thyj

Looks pretty good, thanks @pem70!

Left minor comments related to consistency and documenting the encoding option.

t1m0thyj · 2024-07-15T14:22:58Z

CHANGELOG.md

@@ -8,6 +8,8 @@ All notable changes to the Zowe Client Python SDK will be documented in this fil

 - Included support for `AUTH_TYPE_CERT_PEM` and `AUTH_TYPE_NONE` in `session` [#291] (https://github.com/zowe/zowe-client-python-sdk/issues/291) and [#296] (https://github.com/zowe/zowe-client-python-sdk/issues/296)

+- Updated all functions descriptions to be consitent [#279] (https://github.com/zowe/zowe-client-python-sdk/issues/279)


Suggested change

- Updated all functions descriptions to be consitent [#279] (https://github.com/zowe/zowe-client-python-sdk/issues/279)

- Updated doc strings for all functions to be consistent [#279] (https://github.com/zowe/zowe-client-python-sdk/issues/279)

t1m0thyj · 2024-07-15T14:26:01Z

src/zos_files/zowe/zos_files_for_zowe_sdk/datasets.py

+        data: str
+            Content to be written
+        encoding:
+            Specifies encoding schema


Suggested change

Specifies encoding schema

Specifies encoding name (e.g. IBM-1047)

t1m0thyj · 2024-07-15T14:29:45Z

src/zos_files/zowe/zos_files_for_zowe_sdk/datasets.py

+        output_file:str
+            Name of the local file to create
+        with_prefixes:boolean
+            If true, include a four big endian bytes record length prefix. The default is False


Should we use formatting consistent with get_binary_content?

Suggested change

If true, include a four big endian bytes record length prefix. The default is False

If true, include a four big endian bytes record length prefix. Default: False

t1m0thyj · 2024-07-15T14:30:09Z

src/zos_files/zowe/zos_files_for_zowe_sdk/datasets.py

+        dataset_name: str
+            Name of the dataset to be created
+        encoding: str
+            Specifies the encoding schema


Suggested change

Specifies the encoding schema

Specifies the encoding name (e.g. IBM-1047)

t1m0thyj · 2024-07-15T14:32:07Z

src/zos_files/zowe/zos_files_for_zowe_sdk/file_system.py

+        file_system_name: str
+            the name for the file system
+        options: dict
+            specifies file system attributes


I think we should use sentence case to make the descriptions consistent

Suggested change

file_system_name: str

the name for the file system

options: dict

specifies file system attributes

file_system_name: str

Name of the file system

options: dict

Specifies file system attributes

t1m0thyj · 2024-07-15T14:40:21Z

src/zos_files/zowe/zos_files_for_zowe_sdk/uss.py

+        file_path: str
+            file_path of the file to add
+        type: str
+            "file" or "dir"
+        mode: str
+            Ex:- rwxr-xr-x


Suggested change

file_path: str

file_path of the file to add

type: str

"file" or "dir"

mode: str

Ex:- rwxr-xr-x

file_path: str

Path of the file to add

type: str

Specify either "file" or "dir"

mode: str

Unix permission string (e.g. `rwxr-xr-x`)

t1m0thyj · 2024-07-15T14:40:37Z

src/zos_files/zowe/zos_files_for_zowe_sdk/uss.py

+        data: str
+            Contents to be written
+        encoding: str
+            Specifies the encoding schema


Suggested change

Specifies the encoding schema

Specifies the encoding name (e.g. IBM-1047)

t1m0thyj · 2024-07-15T14:41:44Z

src/zos_files/zowe/zos_files_for_zowe_sdk/datasets.py

+        member_pattern: str
+            Filters members by name pattern.
+        member_start: str
+            The starting point for listing members.
+        limit: int
+            The maximum number of members returned.
+        attributes: str
+            The member attributes to retrieve.


Trailing periods should be removed for consistency

t1m0thyj · 2024-07-15T14:41:50Z

src/zos_files/zowe/zos_files_for_zowe_sdk/datasets.py

@@ -325,6 +381,7 @@ def copy_data_set_or_member(
            Enqueue type for the dataset to copy from
        replace: bool
            If true, members in the target data set are replaced.


Trailing periods should be removed for consistency

t1m0thyj · 2024-07-15T14:43:15Z

src/zos_files/zowe/zos_files_for_zowe_sdk/datasets.py

+        dataset_name: str
+            The name of the dataset
+        stream: bool
+            Specifies


Suggested change

Specifies

Specify True to return content as a stream object instead of a string. Default: False

pem70 · 2024-07-15T18:44:01Z

Merged into a combined pull request.

pem70 added 2 commits July 8, 2024 15:13

Update doc strings

873944e

Signed-off-by: pem70 <[email protected]>

Update CHANGELOG.md

039879c

Signed-off-by: pem70 <[email protected]>

pem70 requested review from t1m0thyj and zFernand0 July 8, 2024 19:16

github-actions bot assigned pem70 Jul 8, 2024

JTonda requested a review from anaxceron July 10, 2024 15:07

zFernand0 changed the base branch from main to Auth_Type July 10, 2024 16:38

Base automatically changed from Auth_Type to main July 12, 2024 19:12

Merge branch 'main' into Doc_string

a2bcf84

t1m0thyj requested changes Jul 15, 2024

View reviewed changes

pem70 closed this Jul 15, 2024

t1m0thyj mentioned this pull request Jul 17, 2024

Doc string enforcer and annotations #312

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update doc strings #307

Update doc strings #307

pem70 commented Jul 8, 2024 •

edited

Loading

codecov bot commented Jul 8, 2024 •

edited

Loading

zFernand0 commented Jul 10, 2024 •

edited

Loading

t1m0thyj left a comment

t1m0thyj Jul 15, 2024

t1m0thyj Jul 15, 2024

t1m0thyj Jul 15, 2024

t1m0thyj Jul 15, 2024

t1m0thyj Jul 15, 2024

t1m0thyj Jul 15, 2024

t1m0thyj Jul 15, 2024

t1m0thyj Jul 15, 2024

t1m0thyj Jul 15, 2024

t1m0thyj Jul 15, 2024

pem70 commented Jul 15, 2024

		@@ -8,6 +8,8 @@ All notable changes to the Zowe Client Python SDK will be documented in this fil

		- Included support for `AUTH_TYPE_CERT_PEM` and `AUTH_TYPE_NONE` in `session` [#291] (https://github.com/zowe/zowe-client-python-sdk/issues/291) and [#296] (https://github.com/zowe/zowe-client-python-sdk/issues/296)

		- Updated all functions descriptions to be consitent [#279] (https://github.com/zowe/zowe-client-python-sdk/issues/279)

	- Updated all functions descriptions to be consitent [#279] (https://github.com/zowe/zowe-client-python-sdk/issues/279)
	- Updated doc strings for all functions to be consistent [#279] (https://github.com/zowe/zowe-client-python-sdk/issues/279)

	Specifies encoding schema
	Specifies encoding name (e.g. IBM-1047)

	If true, include a four big endian bytes record length prefix. The default is False
	If true, include a four big endian bytes record length prefix. Default: False

	Specifies the encoding schema
	Specifies the encoding name (e.g. IBM-1047)

	Specifies
	Specify True to return content as a stream object instead of a string. Default: False

Update doc strings #307

Update doc strings #307

Conversation

pem70 commented Jul 8, 2024 • edited Loading

codecov bot commented Jul 8, 2024 • edited Loading

Codecov Report

zFernand0 commented Jul 10, 2024 • edited Loading

t1m0thyj left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pem70 commented Jul 15, 2024

pem70 commented Jul 8, 2024 •

edited

Loading

codecov bot commented Jul 8, 2024 •

edited

Loading

zFernand0 commented Jul 10, 2024 •

edited

Loading