qiskit-textbook
qiskit-textbook copied to clipboard
qiskit-community
"statevector" vs "state vector"
Describe the issue Though we might want to refer to "statevector" as direct reference to how we type it in python, "statevector" (one word) has been adopted in current language among qiskitters to be synonymous of "state vector" (two words) in any situation.
Describe what you expect to see I noticed that there are some places here where it appears "state vector" instead of "statevector". For the sake of consistency I would propose change it to "statevector". Or not. I'm open to hear what other people think about this.
Thanks
"Stave Vector" is technically the correct word. Many terms in python have no spaces in between, like qiskit.pulse.ShiftPhase etc., for obvious reasons, but in all those cases, qiskit has appropriate uppercasing to emphasise that.
However, qiskit.quantum_info.Statevector doesn't seem to follow that nomenclature. I personally feel we must use "StateVector" (notice the capitalisation) to ensure consistency.
Describe the issue Though we might want to refer to "statevector" as direct reference to how we type it in python, "statevector" (one word) has been adopted in current language among qiskitters to be synonymous of "state vector" (two words) in any situation.
Describe what you expect to see I noticed that there are some places here where it appears "state vector" instead of "statevector". For the sake of consistency I would propose change it to "statevector". Or not. I'm open to hear what other people think about this.
Thanks
Hi, could you cite where you found this anomaly? From what I saw, places where simulator has been referred to it is "statevector" and other wise in content it is "state vector" which is the correct way of representing I suppose. Could you highlight where are you expecting to change it? In the documentation or content?
Check out 1.3 in the qiskit textbook. The same was linked by @omarcostahamido in the issue.
Check out 1.3 in the qiskit textbook. The same was linked by @omarcostahamido in the issue.
Thank you! I completely missed it. So, I would like to work on this issue. I believe "state vector" is the correct representation of the word/words but in the python code it is referred to as "statevector" and not "StateVector" so indicating that it is one word. Any suggestions on which one to implement? I believe we should go with the grammatically correct representation i.e. "state vector". What do you think?
So there are two parts to this. The First would be to replace "statevector" in the textbook contents with "state vector". The second would be to replace "statevector" in qiskit terra with "StateVector".
I actually wanted to take care of this issue. You could maybe open one on terra?
I am glad other people are engaging with this issue now. I have to admit that, even though I recognize "state vector" as the technically correct word, I thought it would be nice to have the new formulation "statevector" that is immediately recognized as a "state vector" being referred to in the context of QC. "statevector" is also easier and faster to write. In any case, going with one or two word variant, consistency is a must. Thank you.
So there are two parts to this. The First would be to replace "statevector" in the textbook contents with "state vector". The second would be to replace "statevector" in qiskit terra with "StateVector".
I actually wanted to take care of this issue. You could maybe open one on terra?
I am not sure if I can work on the issue with qiskit terra.
I have been writing 'statevector' but agree we should go with 'state vector' in the textbook. This can be fixed with a find/replace over all the notebooks. If I were to do this myself, I would use nbconvert to distinguish between text in markdown vs code cells, similar to this script.
