googleapis / googleapis/synthtool

Python: Document how to deprecate methods/classes for libraries in CONTRIBUTING

Open
#1,102 0 comments 0 reactions 0 assignees View on GitHub
type: docs type: process
Dominant language
Python
Stars
108
Forks
102
Avg merge
1h 23m
Merged PRs (30d)
1

Description

This should align with the style we want to use going forward for generated clients:

- Raise `DeprecationWarning`
- Message text follows https://google.aip.dev/192#deprecations
- Use `deprecated` sphinx directive https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-deprecated

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.