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.

Sign up for GitHub

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

Jump to bottom

Fix #563 - Add breadcrumbs to single method docs. #566

Closed
wants to merge 1 commit into from
Closed

Fix #563 - Add breadcrumbs to single method docs. #566

wants to merge 1 commit into from

Conversation

jgeewax
Copy link
Contributor

@jgeewax jgeewax commented May 8, 2015

Need a review... there's some weirdness with this:

  1. ACL methods are weird. They show Storage > Acl > acl.add
  2. Default ACL methods are even weirder: They show Storage > acl.default.add

Also I'm not 100% happy with the code, but not sure how I could make this better. Guidance would be really helpful.....

@jgeewax jgeewax added this to the Core Future milestone May 8, 2015
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label May 8, 2015
@ryanseys
Copy link
Contributor

Yeah this can be resolved by putting acl on Bucket.prototype instead of initialized in the constructor of Bucket. (I quickly fooled around with it and that seemed to resolve it, but left the code in a non-working state). @stephenplusplus can perhaps describe the reason why this was done this way. Seems lots of this scope magic prevents us from moving these methods around more freely I believe.

@stephenplusplus
Copy link
Contributor

Another issue is http://localhost:8000/docs/#/docs/master/datastore/dataset?method=allocateIds showing DatastoreRequest as its parent. Breadcrumbs sounded nice at first, but I wouldn't mind ditching them in favor of the sidebar being the "hierarchy of truth". It's also a little odd why the breadcrumbs are only used on one page, and not all.

(edit: can't believe I gave a localhost link)

@stephenplusplus
Copy link
Contributor

@ryanseys The main issue is to keep Acl generic, it needs information that we don't have until instantiation of our modules.

@ryanseys
Copy link
Contributor

Yeah makes sense. I think sidebar of truth sounds okay to me. Breadcrumbs are messy when we don't use a very specific style of object hierarchy.

@ryanseys
Copy link
Contributor

(edit: can't believe I gave a localhost link)

oh man 🙈

@jgeewax You ok with closing this due to the complexity of this fix given the circumstances noted above? Neat idea, but hard in practice.

@jgeewax
Copy link
Contributor Author

jgeewax commented May 12, 2015

:( Makes me sad, but if it's not worth the effort, so be it.

It just seems weird that we can detect, for every method, what module and class should light up in the sidebar, but we can pick up that same thing and just put in the class (Bucket, File, ...).

I'll close out this PR but leave the main issue open. Maybe there's a better way.

@jgeewax jgeewax closed this May 12, 2015
sofisl pushed a commit that referenced this pull request Sep 27, 2022
@gcf-owl-bot
fix: make request optional in all cases (#566)
ccdc548 
... chore: update gapic-generator-ruby to the latest commit chore: release gapic-generator-typescript 1.5.0

Committer: @miraleung
PiperOrigin-RevId: 380641501

Source-Link: googleapis/googleapis@076f7e9

Source-Link: googleapis/googleapis-gen@27e4c88
sofisl pushed a commit that referenced this pull request Sep 27, 2022
@release-please
chore: release 3.3.4 (#567)
9fb394c 
🤖 I have created a release \*beep\* \*boop\*
---
### [3.3.4](https://www.github.com/googleapis/nodejs-video-intelligence/compare/v3.3.3...v3.3.4) (2021-06-22)


### Bug Fixes

* make request optional in all cases ([#566](https://www.github.com/googleapis/nodejs-video-intelligence/issues/566)) ([ef7abca](https://www.github.com/googleapis/nodejs-video-intelligence/commit/ef7abca3d3d7ba44f0fc8406ebef4a5396147bc4))
---


This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
@sofisl sofisl mentioned this pull request Sep 27, 2022
Closed
4 tasks
@sofisl sofisl mentioned this pull request Oct 12, 2022
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Oct 12, 2022
@gcf-owl-bot
fix: preserve default values in x-goog-request-params header (#566)
0bc6564 
- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 474338479

Source-Link: googleapis/googleapis@d5d35e0

Source-Link: googleapis/googleapis-gen@efcd3f9
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZWZjZDNmOTM5NjJhMTAzZjY4ZjAwM2UyYTFlZWNkZTZmYTIxNmEyNyJ9
@release-please release-please bot mentioned this pull request Oct 12, 2022
Closed
sofisl pushed a commit that referenced this pull request Oct 13, 2022
@gcf-owl-bot @sofisl
fix: preserve default values in x-goog-request-params header (#566)
1b755f1 
- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 474338479

Source-Link: googleapis/googleapis@d5d35e0

Source-Link: googleapis/googleapis-gen@efcd3f9
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZWZjZDNmOTM5NjJhMTAzZjY4ZjAwM2UyYTFlZWNkZTZmYTIxNmEyNyJ9
sofisl pushed a commit that referenced this pull request Nov 9, 2022
@gcf-owl-bot
fix: make request optional in all cases (#566)
a7be52f 
... chore: update gapic-generator-ruby to the latest commit chore: release gapic-generator-typescript 1.5.0

Committer: @miraleung
PiperOrigin-RevId: 380641501

Source-Link: googleapis/googleapis@076f7e9

Source-Link: googleapis/googleapis-gen@27e4c88
sofisl pushed a commit that referenced this pull request Nov 9, 2022
@release-please
chore: release 3.3.4 (#567)
856515a 
🤖 I have created a release \*beep\* \*boop\*
---
### [3.3.4](https://www.github.com/googleapis/nodejs-video-intelligence/compare/v3.3.3...v3.3.4) (2021-06-22)


### Bug Fixes

* make request optional in all cases ([#566](https://www.github.com/googleapis/nodejs-video-intelligence/issues/566)) ([ef7abca](https://www.github.com/googleapis/nodejs-video-intelligence/commit/ef7abca3d3d7ba44f0fc8406ebef4a5396147bc4))
---


This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
This was referenced Nov 9, 2022
Closed
Merged
Merged
sofisl pushed a commit that referenced this pull request Nov 10, 2022
@gcf-owl-bot
build: add generated samples to .eslintignore (#566)
738fa99
@sofisl sofisl mentioned this pull request Nov 10, 2022
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Nov 10, 2022
@release-please
chore: release 2.4.2 (#566)
ba2d25f 
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
sofisl pushed a commit that referenced this pull request Nov 11, 2022
@renovate-bot
chore(deps): update dependency sinon to v13 (#566)
e3d1b48 
[![WhiteSource Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [sinon](https://sinonjs.org/) ([source](https://togithub.com/sinonjs/sinon)) | [`^12.0.0` -> `^13.0.0`](https://renovatebot.com/diffs/npm/sinon/12.0.1/13.0.0) | [![age](https://badges.renovateapi.com/packages/npm/sinon/13.0.0/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/sinon/13.0.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/sinon/13.0.0/compatibility-slim/12.0.1)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/sinon/13.0.0/confidence-slim/12.0.1)](https://docs.renovatebot.com/merge-confidence/) |

---

### Release Notes

<details>
<summary>sinonjs/sinon</summary>

### [`v13.0.0`](https://togithub.com/sinonjs/sinon/blob/HEAD/CHANGES.md#&#8203;1300)

[Compare Source](https://togithub.com/sinonjs/sinon/compare/v12.0.1...v13.0.0)

-   [`cf3d6c0c`](https://togithub.com/sinonjs/sinon/commit/cf3d6c0cd9689c0ee673b3daa8bf9abd70304392)
    Upgrade packages ([#&#8203;2431](https://togithub.com/sinonjs/sinon/issues/2431)) (Carl-Erik Kopseng)
    > -   Update all @&#8203;sinonjs/ packages
    >
    > -   Upgrade to fake-timers 9
    >
    > -   chore: ensure always using latest LTS release
-   [`41710467`](https://togithub.com/sinonjs/sinon/commit/417104670d575e96a1b645ea40ce763afa76fb1b)
    Adjust deploy scripts to archive old releases in a separate branch, move existing releases out of master ([#&#8203;2426](https://togithub.com/sinonjs/sinon/issues/2426)) (Joel Bradshaw)
    > Co-authored-by: Carl-Erik Kopseng <carlerik@gmail.com>
-   [`c80a7266`](https://togithub.com/sinonjs/sinon/commit/c80a72660e89d88b08275eff1028ecb9e26fd8e9)
    Bump node-fetch from 2.6.1 to 2.6.7 ([#&#8203;2430](https://togithub.com/sinonjs/sinon/issues/2430)) (dependabot\[bot])
    > Co-authored-by: dependabot\[bot] <49699333+dependabot\[bot][@&#8203;users](https://togithub.com/users).noreply.github.com>
-   [`a00f14a9`](https://togithub.com/sinonjs/sinon/commit/a00f14a97dbe8c65afa89674e16ad73fc7d2fdc0)
    Add explicit export for `./*` ([#&#8203;2413](https://togithub.com/sinonjs/sinon/issues/2413)) (なつき)
-   [`b82ca7ad`](https://togithub.com/sinonjs/sinon/commit/b82ca7ad9b1add59007771f65a18ee34415de8ca)
    Bump cached-path-relative from 1.0.2 to 1.1.0 ([#&#8203;2428](https://togithub.com/sinonjs/sinon/issues/2428)) (dependabot\[bot])
-   [`a9ea1427`](https://togithub.com/sinonjs/sinon/commit/a9ea142716c094ef3c432ecc4089f8207b8dd8b6)
    Add documentation for assert.calledOnceWithMatch ([#&#8203;2424](https://togithub.com/sinonjs/sinon/issues/2424)) (Mathias Schreck)
-   [`1d5ab86b`](https://togithub.com/sinonjs/sinon/commit/1d5ab86ba60e50dd69593ffed2bffd4b8faa0d38)
    Be more general in stripping off stack frames to fix Firefox tests ([#&#8203;2425](https://togithub.com/sinonjs/sinon/issues/2425)) (Joel Bradshaw)
-   [`56b06129`](https://togithub.com/sinonjs/sinon/commit/56b06129e223eae690265c37b1113067e2b31bdc)
    Check call count type ([#&#8203;2410](https://togithub.com/sinonjs/sinon/issues/2410)) (Joel Bradshaw)
-   [`7863e2df`](https://togithub.com/sinonjs/sinon/commit/7863e2dfdbda79e0a32e42af09e6539fc2f2b80f)
    Fix [#&#8203;2414](https://togithub.com/sinonjs/sinon/issues/2414): make Sinon available on homepage (Carl-Erik Kopseng)
-   [`fabaabdd`](https://togithub.com/sinonjs/sinon/commit/fabaabdda82f39a7f5b75b55bd56cf77b1cd4a8f)
    Bump nokogiri from 1.11.4 to 1.13.1 ([#&#8203;2423](https://togithub.com/sinonjs/sinon/issues/2423)) (dependabot\[bot])
-   [`dbc0fbd2`](https://togithub.com/sinonjs/sinon/commit/dbc0fbd263c8419fa47f9c3b20cf47890a242d21)
    Bump shelljs from 0.8.4 to 0.8.5 ([#&#8203;2422](https://togithub.com/sinonjs/sinon/issues/2422)) (dependabot\[bot])
-   [`fb8b3d72`](https://togithub.com/sinonjs/sinon/commit/fb8b3d72a85dc8fb0547f859baf3f03a22a039f7)
    Run Prettier (Carl-Erik Kopseng)
-   [`12a45939`](https://togithub.com/sinonjs/sinon/commit/12a45939e9b047b6d3663fe55f2eb383ec63c4e1)
    Fix 2377: Throw error when trying to stub non-configurable or non-writable properties ([#&#8203;2417](https://togithub.com/sinonjs/sinon/issues/2417)) (Stuart Dotson)
    > Fixes issue [#&#8203;2377](https://togithub.com/sinonjs/sinon/issues/2377) by throwing an error when trying to stub non-configurable or non-writable properties

*Released by [Carl-Erik Kopseng](https://togithub.com/fatso83) on 2022-01-28.*

</details>

---

### Configuration

📅 **Schedule**: "after 9am and before 3pm" (UTC).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/nodejs-dataproc).
@sofisl sofisl mentioned this pull request Nov 11, 2022
Merged
4 tasks
@sofisl sofisl mentioned this pull request Nov 11, 2022
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Nov 11, 2022
@release-please @gcf-owl-bot
chore(main): release 4.1.3 (#566)
f487c1d 
* chore(main): release 4.1.3

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
@sofisl sofisl mentioned this pull request Nov 11, 2022
Merged
sofisl added a commit that referenced this pull request Nov 11, 2022
@sofisl
build!: update library to use Node 12 (#566)
e1236ec 
* build!: Update library to use Node 12
Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
sofisl pushed a commit that referenced this pull request Nov 11, 2022
@release-please
chore(main): release 3.0.0 (#567)
010a32c 
🤖 I have created a release *beep* *boop*
---


## [3.0.0](googleapis/nodejs-iot@v2.5.1...v3.0.0) (2022-06-20)


### ⚠ BREAKING CHANGES

* update library to use Node 12 (#566)

### Features

* AuditConfig for IAM v1 ([#552](googleapis/nodejs-iot#552)) ([1b1a3d2](googleapis/nodejs-iot@1b1a3d2))


### Bug Fixes

* **deps:** update dependency @google-cloud/pubsub to v3 ([#569](googleapis/nodejs-iot#569)) ([77a2005](googleapis/nodejs-iot@77a2005))
* **deps:** update dependency @google-cloud/storage to v6 ([#568](googleapis/nodejs-iot#568)) ([b15efb4](googleapis/nodejs-iot@b15efb4))


### Build System

* update library to use Node 12 ([#566](googleapis/nodejs-iot#566)) ([1efe654](googleapis/nodejs-iot@1efe654))

---
This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
@sofisl sofisl mentioned this pull request Nov 11, 2022
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Nov 11, 2022
@gcf-owl-bot
fix: change import long to require (#566)
375c1e2 
Source-Link: googleapis/synthtool@d229a12
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest@sha256:74ab2b3c71ef27e6d8b69b1d0a0c9d31447777b79ac3cd4be82c265b45f37e5e
@sofisl sofisl mentioned this pull request Jan 10, 2023
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Jan 10, 2023
@yoshi-automation
chore: generate GAPIC metadata JSON file (#566)
1df8862 
This PR was generated using Autosynth. 🌈

Synth log will be available here:
https://source.cloud.google.com/results/invocations/bca0aeb7-d7c6-4e0a-a65e-f13ab3f23aa9/targets

- [ ] To automatically regenerate this PR, check this box.

PiperOrigin-RevId: 345596855
Source-Link: googleapis/googleapis@d189e87
sofisl pushed a commit that referenced this pull request Jan 24, 2023
@release-please
chore: release 4.0.0 (#566)
fa624fd 
* updated CHANGELOG.md [ci skip]

* updated package.json [ci skip]

* updated samples/package.json [ci skip]

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
sofisl pushed a commit that referenced this pull request Jan 25, 2023
@release-please
chore: release 4.0.0 (#566)
387c06d 
* updated CHANGELOG.md [ci skip]

* updated package.json [ci skip]

* updated samples/package.json [ci skip]

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
@sofisl sofisl mentioned this pull request Sep 13, 2023
Closed
4 tasks
sofisl pushed a commit that referenced this pull request Sep 13, 2023
@gcf-owl-bot
docs: fix docstring formatting (#566)
ec83db6 
* docs: fix docstring formatting

Committer: @parthea
PiperOrigin-RevId: 410565213

Source-Link: googleapis/googleapis@35b8704

Source-Link: googleapis/googleapis-gen@16a2cf9
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMTZhMmNmOTIzYjYzZDVlYmNlMWM4YTk2MWQzNjgwODQ4N2U4OTExNCJ9

* 🦉 Updates from OwlBot

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
@sofisl sofisl mentioned this pull request Sep 14, 2023
Merged
4 tasks
@mikolajroszak mikolajroszak mentioned this pull request May 7, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@stephenplusplus stephenplusplus

Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Milestone
Core Future
Development

Successfully merging this pull request may close these issues.
4 participants
@jgeewax @ryanseys @stephenplusplus @googlebot