Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Library Usage chapter still suggests connect_to_device #532

Closed
bittner opened this issue Nov 28, 2022 · 2 comments
Closed

Library Usage chapter still suggests connect_to_device #532

bittner opened this issue Nov 28, 2022 · 2 comments

Comments

@bittner
Copy link
Contributor

bittner commented Nov 28, 2022

  • YubiKey Manager (ykman) version: 5.0.0
  • How was it installed?: pip install yubikey-manager (latest from PyPI)
  • Operating system and version: Ubuntu Linux 18.04.6 LTS Bionic (and higher)
  • YubiKey model and version: YubiKey 5 NFC (5.4.3)
  • Bug description summary: Code snippets in documentation are outdated

The Library Usage chapter of the documentation still suggests connect_to_device, which was removed/replaced with commit 87bc2e2. The documentation should be updated / adapted accordingly.

Steps to reproduce

Expected result

  • Examples should work.

Actual results and logs

  • Examples fail with ImportError / NameError:
...
NameError: name 'connect_to_device' is not defined
...
ImportError: cannot import name 'connect_to_device' from 'ykman.device'
@bittner bittner mentioned this issue Nov 28, 2022
Open
@dainnilsson
Copy link
Member

Thanks for pointing this out! It has now been addressed in f00c507

@bittner
Copy link
Contributor Author

bittner commented Nov 29, 2022

Thank you for the fix! 💯

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dainnilsson @bittner