Fix #478 : Rename shift and clock matrices to gen_pauli_x and gen_pauli_z

[MohitKambli]

Description

As requested in #478, I have replaced all the variables/comments/function-names/file-names occurrences from shift to gen_pauli_x and clock to gen_pauli_z.
If at all there are any issues regarding these code changes, then do let me know.
Sincere apologies if I have missed any code to be changed or implemented a code incorrectly.
Kindly let me know if any changes are required.

Todos

Notable points that this PR has either accomplished or will accomplish.

• Name change of shift/clock to gen_pauli_x/gen_pauli_z.

Questions

• Question1

Status

• Ready to go

[purva-thakre]

@MohitKambli There are going to be some workflow failures based on the changes you introduced. Refer to the Testing and code_style sections in the docs. https://toqito.readthedocs.io/en/latest/contributing.html#testing

The toqito/matrices module has a folder labeled tests with unit tests for the functions in the module. These require changes as well.

Also make sure the functions you change are not used anywhere else: code of other functions or docstring examples of other functions. We have a workflow that checks for both.

[MohitKambli]

Hello @purva-thakre,
Hope you're doing well.
Sincere apologies for my mistakes.
I went through the ruff and pylint documentation so that I can test my changes.
I figured out where I was going wrong and made changes accordingly.
Thank you for helping me out and letting me know about these code changes.
I have added a commit where I have made the potential changes.
Hope these changes help in resolving the issues I observed.
Sincere apologies if I messed up somewhere.

Thanks and Regards,
Mohit Kambli

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.1%. Comparing base (2c9f0b6) to head (cd6d4d2).
Report is 9 commits behind head on master.

Additional details and impacted files

@@          Coverage Diff           @@
##           master    #479   +/-   ##
======================================
  Coverage    98.1%   98.1%           
======================================
  Files         161     161           
  Lines        3096    3096           
  Branches      753     753           
======================================
  Hits         3038    3038           
  Misses         37      37           
  Partials       21      21           

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

[vprusso]

@MohitKambli There are going to be some workflow failures based on the changes you introduced. Refer to the Testing and code_style sections in the docs. https://toqito.readthedocs.io/en/latest/contributing.html#testing

The toqito/matrices module has a folder labeled tests with unit tests for the functions in the module. These require changes as well.

Also make sure the functions you change are not used anywhere else: code of other functions or docstring examples of other functions. We have a workflow that checks for both.

Hi @MohitKambli. Looks good overall, but I believe you may need to address the comment here that @purva-thakre mentioned. Let us know if that doesn't make sense, and thanks again for your contribution! I think it's close!

[purva-thakre]

@vprusso I think this PR is good to go. The part with the tests folder won't apply here given the conversation in #485

[vprusso]

Awesome, also good on my end as well. Merge when ready, @MohitKambli (after you've addressed the docs issue as mentioned by @purva-thakre )

[MohitKambli]

Hello @vprusso and @purva-thakre,
Hope you're doing well.
As mentioned by @purva-thakre in the previous comment, I had made the code changes and executed the ruff and pylint commands for coding style and testing purposes respectively.
If there are any changes to make in the documentation or anywhere else, then do let me know.
I didn't quite get what needs to be done from my end.
Sincere apologies if I misunderstood anything or missed some part.

Thanks and Regards,
Mohit Kambli

[purva-thakre]

If there are any changes to make in the documentation or anywhere else, then do let me know.

@MohitKambli I think @vprusso's last comment is through his email. he might not have noticed that all workflow jobs pass.

Thanks!