Skip to content

Docs: compute_engine.credentials doesn't render note for service_account_email #382

@bmccutchon

Description

@bmccutchon

On this doc item: https://google-auth.readthedocs.io/en/latest/reference/google.auth.compute_engine.credentials.html#google.auth.compute_engine.credentials.Credentials.service_account_email

The rendered docs say simply The service account email.

However, the docstring has more information:

        """The service account email.

        .. note: This is not guaranteed to be set until :meth`refresh` has been
            called.
        """

Why is this important note not rendered?

Metadata

Metadata

Assignees

Labels

type: docsImprovement to the documentation for an API.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions