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

fix: disambiguate after grouping by packages and versions #132

Merged
merged 1 commit into from
Sep 14, 2021

Conversation

dandhlee
Copy link
Collaborator

If entries need to be disambiguated, it should be done after the entries are grouped into packages/versions to avoid having unique entries to specific version/packages not be disambiguated and left alone without a disambiguation prefix.

New example TOC:

- items:
  - name: Overview
    uid: project-google-cloud-bigquery-storage
  - href: multiprocessing.md
    name: Multiprocessing
  - items:
    - items:
      - name: Overview
        uid: google.cloud.bigquery_storage_v1.client
      - name: BigQueryReadClient
        uid: google.cloud.bigquery_storage_v1.client.BigQueryReadClient
      name: client
      uid: google.cloud.bigquery_storage_v1.client
    - items:
      - name: Overview
        uid: google.cloud.bigquery_storage_v1.reader
      - name: ReadRowsIterable
        uid: google.cloud.bigquery_storage_v1.reader.ReadRowsIterable
      - name: ReadRowsPage
        uid: google.cloud.bigquery_storage_v1.reader.ReadRowsPage
      - name: ReadRowsStream
        uid: google.cloud.bigquery_storage_v1.reader.ReadRowsStream
      name: reader
      uid: google.cloud.bigquery_storage_v1.reader
    - items:
      - name: Overview
        uid: google.cloud.bigquery_storage_v1.services.big_query_read
      - name: BigQueryReadAsyncClient
        uid: google.cloud.bigquery_storage_v1.services.big_query_read.BigQueryReadAsyncClient
      - name: BigQueryReadClient
        uid: google.cloud.bigquery_storage_v1.services.big_query_read.BigQueryReadClient
      name: big_query_read
      uid: google.cloud.bigquery_storage_v1.services.big_query_read

All entries will be stripped off of the prefix unless disambiguation is required, to help shorten entries. Users will still see that they are grouped under specific packages/versions to help tell which packages/versions the entry falls under. From the above example, main difference would be that previously it would have bigquery_storage_v1.client and reader, but now it simply shows client and reader.

Fixes #131

  • Tests pass

@dandhlee dandhlee requested review from busunkim96, tbpg and a team September 13, 2021 21:11
@dandhlee dandhlee requested a review from a team as a code owner September 13, 2021 21:11
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Sep 13, 2021
@dandhlee dandhlee merged commit 53d68fe into main Sep 14, 2021
@dandhlee dandhlee deleted the move_disambiguation branch September 14, 2021 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Disambiguate packages after grouping by package
2 participants