Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Specified the port in the Getting Started -> Basic Usage page in the documentation #238

Merged
merged 4 commits into from
Dec 1, 2023

Conversation

Myrausman
Copy link
Contributor

What It Does

issue resolved #162
Review Checklist
I certify that I have:

@Myrausman Myrausman marked this pull request as draft November 29, 2023 07:27
Copy link
Member

@t1m0thyj t1m0thyj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Myrausman Thanks for your contribution!

In addition to adding the port, these examples need a few other changes to bring them up to date. They're using old code that is no longer the recommended way to load connection details from CLI profiles.

Please make the following changes:


Example 1

from zowe.zos_console_for_zowe_sdk import Console
connection = {
    "host_url": "'<host address>'",
    "port" : 443 , # Include the port if different from the default (443)
    "user": "<user>",
    "password": "<password>",
}

my_console = Console(connection)
  • Rename connection to profile
  • Change host_url to host and remove the extra single quotes (')

Example 2

from zowe.zos_console_for_zowe_sdk import Console

connection = {
    "plugin_profile": "<profile name>>"
}

my_console = Console(connection)

The connection object should be replaced with a profile loaded using the ProfileManager class from the core SDK (see example here).

Copy link

codecov bot commented Nov 29, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c616333) 83.54% compared to head (5ea200a) 83.54%.
Report is 1 commits behind head on main.

❗ Current head 5ea200a differs from pull request most recent head a17bdb6. Consider uploading reports for the commit a17bdb6 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #238   +/-   ##
=======================================
  Coverage   83.54%   83.54%           
=======================================
  Files          34       34           
  Lines        2084     2084           
=======================================
  Hits         1741     1741           
  Misses        343      343           
Flag Coverage Δ
unittests 83.54% <ø> (ø)

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.

@Myrausman Myrausman marked this pull request as ready for review November 30, 2023 11:43
Copy link
Member

@t1m0thyj t1m0thyj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing the changes 🙂 Left one more minor comment

docs/source/usage/examples.rst Outdated Show resolved Hide resolved
Signed-off-by: Maira Usman <[email protected]>
Copy link
Member

@t1m0thyj t1m0thyj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @Myrausman!

Copy link
Member

@zFernand0 zFernand0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating!
LGTM! 😋

@t1m0thyj t1m0thyj merged commit 8c8882f into zowe:main Dec 1, 2023
17 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Specify the port in the Getting Started -> Basic Usage page in the documentation
4 participants