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.

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

Updates for wakepy 0.8.0: Docs + small enhancements #271

Merged
merged 40 commits into from
Apr 23, 2024

Conversation

fohrloop
Copy link
Owner

@fohrloop fohrloop commented Apr 23, 2024

Went through the public API parts of wakepy for the 0.8.0 release, and
updated the API Reference documentation. While fixing the docs, found
and fixed few other additional things.

Docs

  • Add Method, ActivationResult, MethodActivationResult, ActivationError,
    MethodExit and PlatformName to API Reference.
  • Add a lot of more cross-linking in the API Reference.
  • Link colors: links to darker blue, inline code from fuchsia to
    brownish red.
  • List items paragraphs: Remove extra space from above, and add some
    space below.

Method

  • Remove .description attribute. Was never used anywhere.
  • supported_platforms: Made any Method by default to support any
    platforms. This is therefore used as a whitelist. The person
    subclassing Method may then either use the automatic platform
    support check (with supported_platforms), or implement caniuse(), or
    just let the code crash on unsupported systems, which will be then
    handled and the method would be marked as failing one.

Naming: mode_name

  • Use mode_name and method_name consistently everywhere
  • Rename: Method.mode -> Method.mode_name. Makes it easier to
    differentiate if talking about Mode instance or a string.
  • Rename the Mode.from_name parameter modename to mode_name
  • Rename: ActivationResult.modename -> .mode_name
  • Add: MethodActivationResult.mode_name

Dbus Adapter

  • Make the wakepy.dbus_adapters.jeepney.JeepneyDBusAdapter importable
    from wakepy.JeepneyDBusAdapter using lazy-loading from PEP-562.

@fohrloop fohrloop changed the title Docs update for 0.8.0 part5 Updates for wakepy 0.8.0: Docs + small enhancements Apr 23, 2024
@fohrloop fohrloop merged commit 1a6274d into dev Apr 23, 2024
17 checks passed
@fohrloop fohrloop deleted the docs-update-for-0.8.0-part5 branch April 23, 2024 21:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant