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

feat(API): Support read/write signals X-Y #176

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

epage
Copy link
Contributor

@epage epage commented Aug 4, 2017

TODO

  • Make example work 1
  • Integration test 2
  • Decide if its XY or Xy in PascalCase. 1
  • Update readme 3
  • Update example documentation 3

Checklist

  • This contribution adheres to CONTRIBUTING.md.
  • New tests have been created for any new features or regression tests for bugfixes.
  • tox successfully runs, including unit tests and style checks (see CONTRIBUTING.md).

"SignalOutSinglePointSession"]
"SignalOutSinglePointSession",
"SignalInXYSession",
"SignalOutXYSession"]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should it be SignalInXYSession or SignalInXySession?

PEP-8 only says to use CapWords. In newer python stdlib code, ABCMeta caps each part of an acronym.

So far we've been following the convention of not putting acronyms in caps.

Does XY count as an acronym (Xy) or two separate "words" (XY)?

Copy link
Contributor

Choose a reason for hiding this comment

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

So I read "XY" as sort of "X and Y" which would make me inclined to lean more towards XY.

`time_limit` is a good example of why we should rely on both C and LV
documentation for writing documentation for the Python API.  The C
documentation left off what happens if `time_limit` is invalid.
@coveralls
Copy link

coveralls commented Aug 7, 2017

Coverage Status

Coverage increased (+0.7%) to 64.878% when pulling 8bc0344 on epage:xy into 5590c92 on ni:master.

@coveralls
Copy link

coveralls commented Aug 8, 2017

Coverage Status

Coverage increased (+0.7%) to 64.915% when pulling 18a5c68 on epage:xy into d7d9fc9 on ni:master.

1 similar comment
@coveralls
Copy link

coveralls commented Aug 8, 2017

Coverage Status

Coverage increased (+0.7%) to 64.915% when pulling 18a5c68 on epage:xy into d7d9fc9 on ni:master.

@jashnani jashnani added this to Defined in Issue Tracking Feb 5, 2018
@d-bohls d-bohls assigned d-bohls and unassigned bcornish Feb 5, 2018
@jashnani jashnani moved this from Defined to Backlog in Issue Tracking Feb 7, 2018
@salehcDA
Copy link

Are there any plans to continue development on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

None yet

5 participants