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

New example showing user download waveform. #841

Merged
merged 14 commits into from
Feb 6, 2023
Merged

Conversation

yardov
Copy link
Contributor

@yardov yardov commented Feb 1, 2023

Hi reviewers, this is my first attempt to contribute. I wasn't able to do the "Signed-off-by: Name Lastname [email protected]" but my name is in there. Is there I way to add this to a commit via VS Code?
Signed-off-by: Gerardo Orozco [email protected]

What does this Pull Request accomplish?

This is a new RFSG example to show users how to create, normalize and download a user provided waveform. In this case, is multitone and all the code you need is included on this example.
This is specially important for users coming from Playback library. RFSG has now the functionality to do the same but the steps need to be follow correctly to get the exact power right.

Why should this Pull Request be merged?

It's an example.

What testing has been done?

The algorithm is tested with multiple code documented test cases and the limitations are noted there.
The example is written following as close as possible the same guidelines of the other examples at the time of commit.

@reckenro
Copy link
Collaborator

reckenro commented Feb 2, 2023

Sorry, just now getting to this but you should be able to configure black locally to get the python formatted correctly. You can see this Wiki page we have for setting it up: https://github.com/ni/grpc-device/wiki/Development-Tips-and-Tricks#black-format-on-save

@bkeryan
Copy link
Contributor

bkeryan commented Feb 2, 2023

Note that black has configuration options in https://github.com/ni/grpc-device/blob/main/pyproject.toml

Running it locally will automatically use that configuration.

@yardov
Copy link
Contributor Author

yardov commented Feb 2, 2023

@bkeryan thank you, your pointes to the Black configuration helped.
I used: https://black.vercel.app/
I am not able to get it working with my VS Code for some reason.

Now that is passed there, can I assume you guys will give me comments on anything missing for it to make it to the main?

@reckenro
Copy link
Collaborator

reckenro commented Feb 2, 2023

Hi reviewers, this is my first attempt to contribute. I wasn't able to do the "Signed-off-by: Name Lastname [email protected]" but my name is in there. Is there I way to add this to a commit via VS Code?

Honestly, I don't think we've done this across the board and also we Squash Merge before committing to main so I need to look into the policy more and see if we should enforce it more/less. But anyways, I think in VS Code you can do it with the three little dot menu next to the repo in the source control tab:

Commit signed off

I think there's also a more general setting in VS Code to enable it:

image

Copy link
Collaborator

@reckenro reckenro left a comment

Choose a reason for hiding this comment

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

Left a few minor comments but overall looks good to me

@reckenro
Copy link
Collaborator

reckenro commented Feb 2, 2023

@bkeryan thank you, your pointes to the Black configuration helped. I used: https://black.vercel.app/ I am not able to get it working with my VS Code for some reason.

Now that is passed there, can I assume you guys will give me comments on anything missing for it to make it to the main?

Yes, I reviewed and added some more comments. And we have it set up pretty well with required Checks and policies so conversations have to be resolved and there has to be at least one approving reviewer before submitting. After that the merge button at the bottom should go green and you can merge whenever you're ready.

The system tests (run_win_system_tests and run_ubuntu_system_tests) aren't currently marked required because some are intermittent but for this specific change those don't matter because they don't interact with the examples. Mainly just that validate_python step applies to the examples.

@bkeryan
Copy link
Contributor

bkeryan commented Feb 2, 2023

Hi reviewers, this is my first attempt to contribute. I wasn't able to do the "Signed-off-by: Name Lastname [email protected]" but my name is in there. Is there I way to add this to a commit via VS Code?

Honestly, I don't think we've done this across the board and also we Squash Merge before committing to main so I need to look into the policy more and see if we should enforce it more/less. But anyways, I think in VS Code you can do it with the three little dot menu next to the repo in the source control tab:

Commit signed off

I think there's also a more general setting in VS Code to enable it:

image

Sign-off is for compliance with a DCO (Developer Certificate of Origin) and it is different than commit signing (which uses GPG to cryptographically sign commits).

image

@yardov yardov merged commit 5496483 into main Feb 6, 2023
@yardov yardov deleted the users/gorozco/examples branch February 6, 2023 17:42
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.

4 participants