#149 Documentation glitches

v2.6
closed-accepted
Chris Liechti
None
5
2013-10-17
2013-05-30
Ma Xiaojun
No

I'm translating pySerial's documentation to Simplified Chinese.
https://github.com/maxiaojun/pyserial-doc-zh-cn

So I get a change to read the documentation carefully and noted some glitches.

"This installs a package that can be used from Python (import serial)." Is "module" more correct than "package" here? As "package" is also used to mean something different later.

"There is also a Windows installer for end users. It is located in the PyPi.", is this true?

"pySerial 1.21 is compatible with Python 2.0 on Windows, Linux and several un*x like systems, MacOSX and Jython." I feel it ambiguous. I'm not sure whether Jython is considered a platform for Python 2.0 or not. Also why "un*x"?

"pySerial includes a small terminal console based terminal program called Miniterm. It ca be started with ..." An obvious typo here. And "terminal console based terminal program" sounds weird.

The list is not complete yet.

Discussion

  • Chris Liechti
    Chris Liechti
    2013-10-17

    • status: open --> closed-accepted
     
  • Chris Liechti
    Chris Liechti
    2013-10-17

    Thanks, i've fixed the typos.

     
  • Chris Liechti
    Chris Liechti
    2013-10-17

    • Group: v1.0 (example) --> v2.6