1.9. Document Conventions¶
This user’s manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information.
Note
Notes are tips, shortcuts or alternative approaches to the task at hand. Ignoring a note should have no negative consequences, but you might miss out on a time saving procedure.
Warning
The warning sign denotes a hazard, calling attention to a procedure or practice. If a warning is not correctly performed or adhered to, it could result in personal injury. Do not proceed beyond a warning sign until the conditions are fully understood or met.
Caution
The caution sign denotes a hazard, calling attention to a procedure or practice. If a caution is not correctly performed or adhered to, it could result in damage to the product. Do not proceed beyond a caution sign until the conditions are fully understood or met.
Source-code listings are also set in mono-spaced roman but add syntax highlighting as follows:
#!/usr/bin/python
# -*- coding: utf-8 -*-
from serial import Serial
class Magna(Serial):
def __init__(self, port, expected_serial_number=None, log=None):
super(Magna, self).__init__(port, baudrate=19200, timeout=2.0)
self.log = log if log else self.magna_log
self.write('*CLS\r\n')
1.10. Additional Help and Feedback¶
For additional help or to provide feedback about the product’s design and features, please contact: support@magna-power.com.