Add base template for consistent naming convention for functions #2694
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
adam-narozniak
requested review from
danieljanes and
tanertopal
as code owners
danieljanes
approved these changes
Dec 18, 2023
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.
Issue
In
flwr-datasets, the base template was not added (when introducing new docs type) because I didn't see the need for that. I didn't see the need because it affects the public functions, and there are not yet any public functions that could have been documented.The lack of a base template means inconsistent naming.
Description
The base template dictates the basic behavior regarding the generation of the docs for functions.
Related issues/PRs
The same base template is used here #2644
Proposal
Add the same template to
flwr-dataset(here) and toflwr(#2644 ) for docs consistency.