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

[ITensors] [Docs] θ as parameter name in Rz and CRz gates rather than ϕ #1180

Merged
merged 1 commit into from
Aug 22, 2023

Conversation

terasakisatoshi
Copy link
Contributor

Description

When I read code in qubit.jl I found we are supposed to specify keyword arugment θ when creating a Rz (similarly CRz).

The current documentation says "Rz" (takes argument: ϕ), which is not consistent with code in here (similarly CRz).

How Has This Been Tested?

Generate docs locally with the following commands:

$ cd /path/to/ITensors.jl
$ julia --project=docs -e 'using Pkg; Pkg.instantiate()'
$ julia --project=docs -e 'include("docs/make.jl")' 

It is followed by

$ using LiveServer; serve(dir="docs/build")
image image

Checklist:

  • My code follows the style guidelines of this project. Please run using JuliaFormatter; format(".") in the base directory of the repository (~/.julia/dev/ITensors) to format your code according to our style guidelines.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have added tests that verify the behavior of the changes I made.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • Any dependent changes have been merged and published in downstream modules.

@mtfishman
Copy link
Member

Thanks!

@mtfishman mtfishman merged commit b54e8d7 into ITensor:main Aug 22, 2023
@mtfishman mtfishman changed the title Fix doc: use θ as parameter name in Rz and CRz gates rather than ϕ [ITensors] [Docs] θ as parameter name in Rz and CRz gates rather than ϕ Aug 22, 2023
@terasakisatoshi terasakisatoshi deleted the fix-parameter-name-Rz branch August 23, 2023 04:20
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.

2 participants