From 5eea8c4f533a32d2b81b1b69e48d3bb47f1bc5b4 Mon Sep 17 00:00:00 2001 From: Daniel Sanche Date: Fri, 20 Nov 2020 11:21:41 -0800 Subject: [PATCH] docs: removed stackdriver branding (#44) --- google/cloud/error_reporting/__init__.py | 2 +- google/cloud/error_reporting/_logging.py | 8 ++++---- google/cloud/error_reporting/client.py | 7 +++---- google/cloud/error_reporting/util.py | 6 +++--- samples/snippets/api/README.rst | 6 +++--- samples/snippets/api/README.rst.in | 4 ++-- setup.py | 2 +- tests/system/test_system.py | 2 +- 8 files changed, 18 insertions(+), 19 deletions(-) diff --git a/google/cloud/error_reporting/__init__.py b/google/cloud/error_reporting/__init__.py index 9443b99e..8cbe3963 100644 --- a/google/cloud/error_reporting/__init__.py +++ b/google/cloud/error_reporting/__init__.py @@ -12,7 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""Client library for Stackdriver Error Reporting""" +"""Client library for Error Reporting""" from pkg_resources import get_distribution diff --git a/google/cloud/error_reporting/_logging.py b/google/cloud/error_reporting/_logging.py index 5832cc7e..74369a7c 100644 --- a/google/cloud/error_reporting/_logging.py +++ b/google/cloud/error_reporting/_logging.py @@ -12,10 +12,10 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""Interact with Stackdriver Error Reporting via Logging API. +"""Interact with Error Reporting via Logging API. -It's possible to report Stackdriver Error Reporting errors by formatting -structured log messages in Stackdriver Logging in a given format. This +It's possible to report Error Reporting errors by formatting +structured log messages in Cloud Logging in a given format. This client provides a mechanism to report errors using that technique. """ @@ -23,7 +23,7 @@ class _ErrorReportingLoggingAPI(object): - """Report to Stackdriver Error Reporting via Logging API + """Report to Error Reporting via Logging API :type project: str :param project: the project which the client acts on behalf of. If not diff --git a/google/cloud/error_reporting/client.py b/google/cloud/error_reporting/client.py index c4cb816e..ce35981e 100644 --- a/google/cloud/error_reporting/client.py +++ b/google/cloud/error_reporting/client.py @@ -12,7 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""Client for interacting with the Stackdriver Error Reporting API""" +"""Client for interacting with the Error Reporting API""" import os import traceback @@ -317,7 +317,7 @@ def _send_error_report( self.report_errors_api.report_error_event(error_report) def report(self, message, http_context=None, user=None): - """ Reports a message to Stackdriver Error Reporting + """ Reports a message to Error Reporting https://cloud.google.com/error-reporting/docs/formatting-error-messages @@ -362,8 +362,7 @@ def report(self, message, http_context=None, user=None): ) def report_exception(self, http_context=None, user=None): - """ Reports the details of the latest exceptions to Stackdriver Error - Reporting. + """ Reports the details of the latest exceptions to Error Reporting. :type http_context: :class`google.cloud.error_reporting.HTTPContext` :param http_context: The HTTP request which was processed when the diff --git a/google/cloud/error_reporting/util.py b/google/cloud/error_reporting/util.py index 151540cd..8f8434e9 100644 --- a/google/cloud/error_reporting/util.py +++ b/google/cloud/error_reporting/util.py @@ -12,7 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""Utility functions for Stackdriver Error Reporting.""" +"""Utility functions for Error Reporting.""" from google.cloud.error_reporting.client import HTTPContext @@ -35,8 +35,8 @@ def build_flask_context(request): :param request: The Flask request object to convert. :rtype: :class:`~google.cloud.error_reporting.client.HTTPContext` - :returns: An HTTPContext object ready to be sent to the Stackdriver Error - Reporting API. + :returns: An HTTPContext object ready to be sent to the Error Reporting + API. """ return HTTPContext( url=request.url, diff --git a/samples/snippets/api/README.rst b/samples/snippets/api/README.rst index 74bcd639..fe98a482 100644 --- a/samples/snippets/api/README.rst +++ b/samples/snippets/api/README.rst @@ -1,19 +1,19 @@ .. This file is automatically generated. Do not edit this file directly. -Stackdriver Error Reporting Python Samples +Error Reporting Python Samples =============================================================================== .. image:: https://gstatic.com/cloudssh/images/open-btn.png :target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=error_reporting/api/README.rst -This directory contains samples for Stackdriver Error Reporting. `Stackdriver Error Reporting`_ aggregates and displays errors produced in +This directory contains samples for Error Reporting. `Error Reporting`_ aggregates and displays errors produced in your running cloud services. -.. _Stackdriver Error Reporting: https://cloud.google.com/error-reporting/docs/ +.. _Error Reporting: https://cloud.google.com/error-reporting/docs/ Setup ------------------------------------------------------------------------------- diff --git a/samples/snippets/api/README.rst.in b/samples/snippets/api/README.rst.in index ac60cc80..56f4080f 100644 --- a/samples/snippets/api/README.rst.in +++ b/samples/snippets/api/README.rst.in @@ -1,11 +1,11 @@ # This file is used to generate README.rst product: - name: Stackdriver Error Reporting + name: Error Reporting short_name: Error Reporting url: https://cloud.google.com/error-reporting/docs/ description: > - `Stackdriver Error Reporting`_ aggregates and displays errors produced in + `Error Reporting`_ aggregates and displays errors produced in your running cloud services. setup: diff --git a/setup.py b/setup.py index fe3932ed..0c162438 100644 --- a/setup.py +++ b/setup.py @@ -21,7 +21,7 @@ # Package metadata. name = "google-cloud-error-reporting" -description = "Stackdriver Error Reporting API client library" +description = "Error Reporting API client library" version = "1.0.0" # Should be one of: # 'Development Status :: 3 - Alpha' diff --git a/tests/system/test_system.py b/tests/system/test_system.py index 77c00646..28125c6a 100644 --- a/tests/system/test_system.py +++ b/tests/system/test_system.py @@ -24,7 +24,7 @@ from test_utils.system import unique_resource_id -ERROR_MSG = "Stackdriver Error Reporting System Test" +ERROR_MSG = "Error Reporting System Test" def setUpModule():