search

baudm / mplayer.py

Lightweight Python wrapper for MPlayer
http://pypi.python.org/pypi/mplayer.py
GNU Lesser General Public License v3.0
117 stars 32 forks source link

documentation incorrect for Player class #40

Closed mikeblas closed 3 years ago

mikeblas commented 3 years ago

The docs for the Player suggest importing a class named CommandPrefix, but the corrent name is CmdPrefix. Note tthe wrong name is given in 2 different import statements on that page.

baudm commented 3 years ago

The documentation clearly states that CmdPrefix was previously named CommandPrefix in the 0.6.0 release.

mikeblas commented 3 years ago

Actually, in one spot, it says "NOTE: In 0.6.0, this was named as command_prefix", lowercase with an underbar. In another spot, it says "NOTE: In 0.6.0, CmdPrefix is named as CommandPrefix", mixed case with no underbar.

One code example uses "CommandPrefix", another uses "CmdPrefix".

Problem is, the documentation doesn't make it clear what the class is called in present-day builds. Turns out it's "CmdPrefix" and not "CommandPrefix", and also not "command_prefix".