Add since metadata across the public API and bump the version to 0.10.0 - #32
Merged
Merged
Conversation
ExDoc renders `@doc since:` as a badge and lets readers filter by release, so the runtime-reconfiguration API (update_device_config/2, update_adapters/2, disconnect_clients/2, DeviceConfig.merge/2 and validate/1) and the serial-proxy line-state advertisement are tagged 0.10.0. Options and fields that have no function to tag carry a prose note instead. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Every public module, function and callback added after 0.1.0 now carries the release that introduced it (derived from the tag history: 0.2.0 Bluetooth proxy and scanner modules, 0.4.0 PskStore and put_psk/2, 0.5.0 ClientInfo / ConnectionListener / connected_clients/1 / client_registry_name/1, 0.7.0 push_zwave_home_id/2, 0.8.0 default_open_opts, 0.9.0 handle_command/2), alongside the 0.10.0 additions tagged in the previous commit. Options and fields with no function to tag carry a prose note. Nothing in the public API is deprecated, so no deprecated metadata is needed. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
bbangert
changed the title
There was a problem hiding this comment.
🟢 Approval recommended
The documentation metadata matches the reviewed release history, and the version bump introduces no unresolved functional risk.
Pull request overview
Adds release-history metadata across the public API and prepares version 0.10.0.
Changes:
- Adds
sincemetadata to modules, functions, and callbacks. - Documents newly introduced options, fields, and arguments.
- Bumps the package version to 0.10.0.
File summaries
| File | Description |
|---|---|
mix.exs |
Bumps the package version. |
lib/espex.ex |
Annotates public runtime APIs. |
lib/espex/supervisor.ex |
Documents runtime reconfiguration history. |
lib/espex/device_config.ex |
Annotates configuration APIs. |
lib/espex/entity_provider.ex |
Annotates the contextual command callback. |
lib/espex/serial_proxy.ex |
Annotates serial defaults and configuration. |
lib/espex/serial_proxy/info.ex |
Documents line-state additions. |
lib/espex/psk_store.ex |
Adds module introduction metadata. |
lib/espex/client_info.ex |
Adds module introduction metadata. |
lib/espex/connection_listener.ex |
Adds module introduction metadata. |
lib/espex/bluetooth_scanner.ex |
Adds module introduction metadata. |
lib/espex/bluetooth_proxy.ex |
Adds module introduction metadata. |
lib/espex/bluetooth_proxy/service.ex |
Adds struct-module metadata. |
lib/espex/bluetooth_proxy/characteristic.ex |
Adds struct-module metadata. |
lib/espex/bluetooth_proxy/descriptor.ex |
Adds struct-module metadata. |
Review details
- Files reviewed: 15/15 changed files
- Comments generated: 0
- Review effort level: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@moduledoc since:on modules that arrived whole in a later release:Espex.BluetoothProxyand itsCharacteristic/Descriptor/Servicestructs,Espex.BluetoothScanner(0.2.0);Espex.PskStore(0.4.0);Espex.ClientInfo,Espex.ConnectionListener(0.5.0).@doc since:on functions and callbacks added to pre-existing modules:DeviceConfig.put_psk/2(0.4.0);Espex.connected_clients/1,Supervisor.client_registry_name/1(0.5.0);Espex.push_zwave_home_id/2(0.7.0);SerialProxy.default_open_opts/0and thec:default_open_opts/1callback (0.8.0);c:EntityProvider.handle_command/2(0.9.0);Espex.update_device_config/2,Espex.update_adapters/2,Espex.disconnect_clients/2,DeviceConfig.merge/2,DeviceConfig.validate/1,SerialProxy.Info.line_states_to_bits/1(0.10.0).disconnect_grace_msoption, theconfigured_line_statesfield, and thereasonargument.deprecated:metadata.mix.exsversion 0.9.0 → 0.10.0.Derived from the tag history with an AST walk over every release;
mix docsreports no new warnings.🤖 Generated with Claude Code