Minor doc improvements for recent changes #79
Merged
Conversation
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
- Add missing CHANGELOG entry for new API - Fix mispelled ModulemdDefaultsUnit class in docs - Add all the SyncOptions classes into docs - Fix wrong copy-pasted summary on YumSyncOptions - Add "versionadded" a few places for sync to help record which minimum version is needed to use this feature - Add a "seealso" on SyncOptions to help find the other related classes - Fix links from SyncOptions back to sync method (linking to inherited sync() method on repository subclasses doesn't seem to work) - Tweak how the default argument to sync() is set; it's functionally equivalent to how it was before, but renders more nicely in docs.
midnightercz
requested changes
Feb 24, 2020
| ## [Unreleased] | ||
|
|
||
| - N/A | ||
| ### Added |
Member
There was a problem hiding this comment.
can you move this to [2.5.0] so we can release the changes after PR is merged?
Contributor
Author
There was a problem hiding this comment.
That's normally done right at the time of release because you don't know the date of the release otherwise.
midnightercz
approved these changes
Feb 24, 2020
chandwanitulsi
approved these changes
Feb 24, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Add missing CHANGELOG entry for new API
Fix mispelled ModulemdDefaultsUnit class in docs
Add all the SyncOptions classes into docs
Fix wrong copy-pasted summary on YumSyncOptions
Add "versionadded" a few places for sync to help record which
minimum version is needed to use this feature
Add a "seealso" on SyncOptions to help find the other related
classes
Fix links from SyncOptions back to sync method (linking to
inherited sync() method on repository subclasses doesn't seem to
work)
Tweak how the default argument to sync() is set; it's functionally
equivalent to how it was before, but renders more nicely in docs.