pingo-io / pingo-py

Generic API for controlling boards with programmable IO pins
http://pingo.io
MIT License
257 stars 48 forks source link

board = pingo.detect.get_board() or board = pingo.detect.MyBoard() ? #101

Open scls19fr opened 8 years ago

scls19fr commented 8 years ago

Hello,

in http://www.pingo.io/docs/ we can see

board = pingo.detect.MyBoard()

but in https://github.com/pingo-io/pingo-py/blob/master/README.rst we see

board = pingo.detect.get_board()

When I see https://github.com/pingo-io/pingo-py/blob/master/pingo/detect/detect.py I noticed

def get_board():
    pass

# TODO: deprecate legacy "MyBoard" factory name
MyBoard = get_board

Thks to @lwalter86 for showing me this issue.

Vido commented 7 years ago

Hi @scls19fr

The correct function is get_board. The old MyBoard was kept for compatibility

@ramalho , Can you fix the pingo.io docs?

Thanks.