Skip to content

Improve readability and wording#172

Open
aitestino wants to merge 6 commits into
CiscoTestAutomation:mainfrom
aitestino:aetest-parameters-doc-improv
Open

Improve readability and wording#172
aitestino wants to merge 6 commits into
CiscoTestAutomation:mainfrom
aitestino:aetest-parameters-doc-improv

Conversation

@aitestino

Copy link
Copy Markdown

Corrected typos, sentence structure, and overall added clarity.

@aitestino
aitestino requested a review from a team as a code owner July 22, 2022 18:56
@aitestino
aitestino requested review from GerriorL and bastell July 22, 2022 18:56

@GerriorL GerriorL left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for taking the time to edit the documentation! However, in this case since "testscript" and "testcase" are in reference to internal classes they should be left as is.

@mjbear

mjbear commented Nov 5, 2024

Copy link
Copy Markdown

@GerriorL @aitestino
Do we want to capitalize Testcase or Testscript?

Similar as to was done here (but probably without adding the back ticks for inline code).
https://github.com/CiscoTestAutomation/pyats/pull/172/files#diff-9151667b9761d14c0d878feb1a7493271163d038dc15019ed2613ba0fc33e199R349

@GerriorL

GerriorL commented Nov 5, 2024

Copy link
Copy Markdown
Contributor

@GerriorL @aitestino Do we want to capitalize Testcase or Testscript?

I think that would be for the best

@mjbear

mjbear commented Nov 5, 2024

Copy link
Copy Markdown

@aitestino
These are some great clarity improvements!

Apologies for the likely flood of GH emails. I started by using the webui code review feature and I really should have gone the distance and submit a pull request to you. (That's what I'm doing now as aitestino#1.)

.. _Variable Scoping: https://docs.python.org/3.4/reference/executionmodel.html

``aetest`` is a data-driven test infrastructure. Its scripts and testcases are
``aetest`` is a data-driven test infrastructure. Its scripts and test cases are

@mjbear mjbear Nov 5, 2024

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I agree with the change on this line.
Here this is not a code object, but instead a normal English noun.

@mjbear

mjbear commented Nov 7, 2024

Copy link
Copy Markdown

@GerriorL
Updates have been made.
Thank you for reviewing them when you have time!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants