Findings in the docs
68040 opened this issue · 5 comments
Some little findings in the docs
docs/data/protocol
- The "t" is missing in "swicher" in the complete doc.
- swicher.atem.switcherPortTypes: Typo. The point "multiviewer" is written with a lower "V"
- swicher.atem.mixEffects
mixEffect1..4: Range. The values are 0..3
docs/logging/
switcher.setLogLevel(logging.DEBUG): This loglevel has no effect
docs/methods/exec/
- execCutME, execAutoME, execFadeToBlackME
mE: see ATEMMixEffects: There's no "ATEMMixEffects"-reference in the docs.
docs/methods/set/
- setCameraControlZoomSpeed
zoomSpeed (float): 0.0-1.0: The range of zoom speed values should be -1.0-1.0
docs/examples/scan/
for i in range(1,255):The loop should stop at 254
docs/examples/scan-query/
- The loop should stop at 254
for i in range(1,255):
range(1,255) stopes at 254.
you can try it with
for i in range(1,255):
print(i)
switcher.atem.mixeffects mixEffect1..4: The names are MixEffect1..4 the values are 0..3
>>> switcher.atem.mixEffects.mixEffect1
PyATEMMax.ATEMProtocolEnums.ATEMConstant(name=mixEffect1, value=0)
Let's see if I can answer them all...
docs/data/protocol
-
The "t" is missing in "swicher" in the complete doc.
- Pull request #24 merged, thanks !!
- Also found an extra one and fixed it (sorry, forgot to link the commit to this issue).
-
swicher.atem.switcherPortTypes: Typo. The point "multiviewer" is written with a lower "V"
- Fixed with this commit.
-
swicher.atem.mixEffects
mixEffect1..4: Range. The values are 0..3- As pointed by @sierrax369, the value of
mixEffects.mixEffect1is0and so on... - Anyway, I added an extra comment in the docs, just in case.
- As pointed by @sierrax369, the value of
docs/logging/
-
switcher.setLogLevel(logging.DEBUG): This loglevel has no effect- Doesn't it ? I just tried it with the scheduled-tasks example, and if I change the log level in line 103 to
logging.DEBUGthe output of the example changes substantially. Please tell me if it doesn't work for you (or open a separate issue).
- Doesn't it ? I just tried it with the scheduled-tasks example, and if I change the log level in line 103 to
docs/methods/exec/
-
execCutME, execAutoME, execFadeToBlackME
mE: see ATEMMixEffects: There's no "ATEMMixEffects"-reference in the docs.- Yes, you are right :) The reference talks about this class in the code.
- If you try to find "mixEffects" in the protocol constants page of the docs you'll be able to find it.
- Anyway, I added the class names in this list.
docs/methods/set/
-
setCameraControlZoomSpeed
zoomSpeed (float): 0.0-1.0: The range of zoom speed values should be -1.0-1.0- It turns out not only the docs were wrong, the code also was using that range.
- Fixed with this commit.
docs/examples/scan/
-
for i in range(1,255):The loop should stop at 254- As pointed by @sierrax369,
range(1,255)returns values from0to254(see Python range docs).
- As pointed by @sierrax369,
docs/examples/scan-query/
-
The loop should stop at 254
for i in range(1,255):- Same as before.
Version 1.0b8 already available.
"As pointed by @sierrax369, range(1,255) returns values from 0 to 254 (see Python range docs)."
values from 1 to 254 ;-)