Skip to content

Commit

Permalink
docs: removed stackdriver branding (#44)
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel-sanche committed Nov 20, 2020
1 parent e96b833 commit 5eea8c4
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 19 deletions.
2 changes: 1 addition & 1 deletion google/cloud/error_reporting/__init__.py
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions google/cloud/error_reporting/_logging.py
Expand Up @@ -12,18 +12,18 @@
# 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.
"""

import google.cloud.logging.client


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
Expand Down
7 changes: 3 additions & 4 deletions google/cloud/error_reporting/client.py
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions google/cloud/error_reporting/util.py
Expand Up @@ -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

Expand All @@ -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,
Expand Down
6 changes: 3 additions & 3 deletions 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
-------------------------------------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions 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:
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -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'
Expand Down
2 changes: 1 addition & 1 deletion tests/system/test_system.py
Expand Up @@ -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():
Expand Down

0 comments on commit 5eea8c4

Please sign in to comment.