dbus: fix deprecated marks and docs #369
Merged
Conversation
This file contains 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
1. Fix "Deprecated:" annocations. They must be at the start of a new paragraph (IOW it needs an empty line before), otherwise tools (linters etc.) don't see them. 2. It is weird that the deprecated functions are documented, while the non-deprecated ones just refer to the deprecated ones. Move the documentation to non-deprecated functions. 3. Address some nits in docs: - add missing documentation for some methods; - add missing punctuation; - fix bad formatting (in particular, markdown is not supported); - minor rewording in a few places. Fixes: 7172a8d ("dbus: add context-aware methods") Fixes: c51f092 ("dbus: add context to open functions") Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
|
Thanks for the cleanup, LGTM. |
lucab
approved these changes
May 3, 2021
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.
Fix
Deprecated:annocations. They must be at the start of a newparagraph (IOW it needs an empty line before), otherwise tools
(linters etc.) don't see them. Ref: https://github.com/golang/go/wiki/Deprecated
It is weird that the deprecated functions are documented, while
the non-deprecated ones just refer to the deprecated ones.
Move the documentation to non-deprecated functions.
Address some nits in docs:
Fixes: 7172a8d ("dbus: add context-aware methods") PR #340
Fixes: c51f092 ("dbus: add context to open functions") PR #341