Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BetaAnalyticsDataClient is documented as deprecated #7030

Closed
cawa-93 opened this issue Feb 6, 2024 · 3 comments
Closed

BetaAnalyticsDataClient is documented as deprecated #7030

cawa-93 opened this issue Feb 6, 2024 · 3 comments
Assignees
Labels
type: docs Improvement to the documentation for an API.

Comments

@cawa-93
Copy link

cawa-93 commented Feb 6, 2024

The BetaAnalyticsDataClient has {@inheritdoc} inline tag

/** {@inheritdoc} */
class BetaAnalyticsDataClient extends BetaAnalyticsDataGapicClient
{
// This class is intentionally empty, and is intended to hold manual additions to
// the generated {@see BetaAnalyticsDataGapicClient} class.
}

And inherit its docs from BetaAnalyticsDataGapicClient. But BetaAnalyticsDataGapicClient marked as @deprecated

*
* @deprecated Please use the new service client {@see \Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient}.
*/
class BetaAnalyticsDataGapicClient
{
use GapicClientTrait;

This leads to a false-positive deprecation warning:

BetaAnalyticsDataClient is deprecated. 

Please use the new service client {@see \Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient}
@cawa-93
Copy link
Author

cawa-93 commented Feb 6, 2024

Same for AnalyticsAdminServiceClient

/** {@inheritdoc} */
class AnalyticsAdminServiceClient extends AnalyticsAdminServiceGapicClient
{
// This class is intentionally empty, and is intended to hold manual additions to
// the generated {@see AnalyticsAdminServiceGapicClient} class.
}

*
* @deprecated Please use the new service client {@see \Google\Analytics\Admin\V1beta\Client\AnalyticsAdminServiceClient}.
*/
class AnalyticsAdminServiceGapicClient
{
use GapicClientTrait;

@Hectorhammett
Copy link

Hey @cawa-93!

Thanks for letting us know, will take a look on this for a proper solution.

@Hectorhammett Hectorhammett self-assigned this May 6, 2024
@Hectorhammett Hectorhammett added the type: docs Improvement to the documentation for an API. label May 10, 2024
@bshaffer
Copy link
Contributor

bshaffer commented May 10, 2024

Discussed offline but to summarize, these are separate classes. Let me try to explain better:

  • The class Google\Analytics\Data\V1beta\BetaAnalyticsDataClient is deprecated, and it extends Google\Analytics\Data\V1beta\Gapic\BetaAnalyticsDataClient. Both of these classes are deprecated, and they recommend using Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient instead.
  • The class Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient is NOT deprecated (notice it includes an extra Client namespace), and is the one recommended for use.

This is the same for the other classes you've listed. Sorry for the confusion - we will be removing the deprecated classes soon.

That being said, the messaging could absolutely be more clear, and we will work to improve this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Development

No branches or pull requests

3 participants