Skip to content

Conversation

@sachinprasadhs
Copy link
Collaborator

Added Usage: Example usage: and Sample usage: to highlight in bold, which is having numerous entries in keras.io.

Example:
https://keras.io/api/keras_cv/layers/augmentation/random_augmentation_pipeline/
https://keras.io/api/keras_nlp/models/gemma/gemma_backbone/

@fchollet
Copy link
Contributor

I'd rather we standardize the docstrings on either Examples: or Example: or Usage:.

@sachinprasadhs
Copy link
Collaborator Author

sachinprasadhs commented Mar 18, 2024

I'd rather we standardize the docstrings on either Examples: or Example: or Usage:.

Makes sense, shall I make the changes in the code or use the same logic to write something like
docstring = docstring.replace("Example usage:", "# Example\n")

@fchollet
Copy link
Contributor

I would recommend converting all the titles containing "usage" to just "Example usage:"

@sachinprasadhs
Copy link
Collaborator Author

Closing this PR since it is no longer needed and all the usages and examples are converted to Example: or Examples:

keras-team/keras#19344
keras-team/keras-cv#2399
keras-team/keras-hub#1516

@sachinprasadhs sachinprasadhs deleted the sachinprasadhs-patch-2 branch March 20, 2024 20:59
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.

2 participants