[go: nahoru, domu]
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

docs. #108

Merged
merged 1 commit into from
Aug 19, 2014
Merged

docs. #108

merged 1 commit into from
Aug 19, 2014

Conversation

stephenplusplus
Copy link
Contributor

RE: #19

Did a sweep of the Datastore doc blocks, as well as laid the groundwork for docs to come. Thanks to jsdoc2md, 5 files are generated in a new docs directory, one for each service/module: "Common", "Datastore", "PubSub", "Storage", and one for lib/index, which is generated as the default "readme.md" for the directory.

For a look at the rendered results, see https://github.com/stephenplusplus/gcloud-node/blob/docs/docs/datastore.md

@rakyll
Copy link
Contributor
rakyll commented Aug 14, 2014

Looks like a great start. Quick question, should be move the internal modules such as datastore/entity to another directory to exclude them from docs or annotate them with private?

@beriberikix
Copy link
Contributor

+1 for marking private methods. Also, what's with random eject icon only on the classes?

@stephenplusplus
Copy link
Contributor Author

@rakyll I went over entity, and marked all but 3 methods as private: Key, Int, and Double - they aren't used directly by the consumer, but as they are already documented in entity.js, I kept them public so our datastore helper methods (datastore.key, datastore.int, and datastore.double) could use their docs.

However, I think jsdoc2md may have a bug, as it doesn't seem to recognize @borrows, which should handle making that link connection. The same code works as expected when outputting jsdoc HTML directly.

https://github.com/stephenplusplus/gcloud-node/blob/docs/docs/datastore.md#datastoreentity

@stephenplusplus stephenplusplus mentioned this pull request Aug 15, 2014
Merged
@stephenplusplus
Copy link
Contributor Author

Updated 💯

@rakyll
Copy link
Contributor
rakyll commented Aug 18, 2014

I was thinking we should also provide examples for user facing calls -- mostly what we cover on the README. We don't have bandwidth to maintain samples all across the client. And most of them are tautological, reading JSDocs would give an idea.

@silvolu thinks similarly AFAIK.

@silvolu
Copy link
Contributor
silvolu commented Aug 18, 2014

Yep! After a quick skim most of it looks already covered, I the only missing one I could see are for CRUD operations in datastore/entity.js: you're borrowing from transaction, but that will pull in the transaction code sample as well right?

@stephenplusplus
Copy link
Contributor Author

I believe most of the readme Dataset examples are covered.

@silvolu I think you meant datastore/dataset.js. Like you said, those are linked to transaction, so the docs would link over to the signature and examples from there. That's at least how the official JSDoc interpreter will see them; if we decide on a tool to output the docs that doesn't support @borrows, we would probably have to double up on our definitions.

@silvolu
Copy link
Contributor
silvolu commented Aug 18, 2014

Yeah sorry, that's what I meant. Wouldn't the resulting sample be incorrect though? (e.g. ds.get vs transaction.get)

@stephenplusplus
Copy link
Contributor Author

Yeah, it would show the examples in the context of a transaction. We can override the examples for those, hopefully still allowing the description/signature to match. We would end up with identical examples (minus the object name change), but if you think that's a fair price, I'll be happy to override 👍

@silvolu
Copy link
Contributor
silvolu commented Aug 18, 2014

Yeah, I think this one is a small dup that we need: the relation between the dataset operation and the transaction might not be immediately clear, and the sample could confuse the user.
Thanks!

@stephenplusplus
Copy link
Contributor Author

No problemo! I'll probably save that for tomorrow. Feel free to merge as-is if this is blocking anything, I can always send another PR for the example updates.

rakyll pushed a commit that referenced this pull request Aug 19, 2014
Merge pull request #108 from stephenplusplus/docs
7b3b24a 
docs.
@rakyll rakyll merged commit 7b3b24a into googleapis:master Aug 19, 2014
@rakyll
Copy link
Contributor
rakyll commented Aug 19, 2014

I'm merging this, then.

@stephenplusplus stephenplusplus mentioned this pull request Aug 19, 2014
Merged
chingor13 pushed a commit that referenced this pull request Aug 22, 2022
@JustinBeckwith
docs: update links in contrib guide (#108)
ee3eb5d
chingor13 pushed a commit that referenced this pull request Sep 12, 2022
@gcf-owl-bot
test(nodejs): remove 15 add 16 (#1322) (#108)
9faa3f1
chingor13 pushed a commit that referenced this pull request Sep 14, 2022
@gcf-owl-bot
test(nodejs): remove 15 add 16 (#1322) (#108)
b5fbf85
@sofisl sofisl mentioned this pull request Sep 16, 2022
Closed
4 tasks
sofisl pushed a commit that referenced this pull request Sep 16, 2022
@JustinBeckwith
chore: update eslintignore config (#108)
36baeb1
sofisl pushed a commit that referenced this pull request Sep 27, 2022
@renovate @JustinBeckwith
chore(deps): update dependency eslint-plugin-prettier to v3 (#108)
ff1d582
@sofisl sofisl mentioned this pull request Sep 27, 2022
Closed
4 tasks
sofisl pushed a commit that referenced this pull request Oct 5, 2022
@JustinBeckwith
chore: update eslintignore config (#108)
919fe07
This was referenced Oct 5, 2022
Closed
Closed
sofisl pushed a commit that referenced this pull request Oct 8, 2022
@JustinBeckwith
chore: update eslintignore config (#108)
b5686ed
@sofisl sofisl mentioned this pull request Oct 11, 2022
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Nov 11, 2022
@renovate-bot
chore(deps): update dependency sinon to v13 (#108)
c58cca6 
[![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-appengine-admin).
@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
chore(main): release 1.3.0 (#108)
91b6f2d 
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
@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: preserve default values in x-goog-request-params header (#108)
5877838 
- [ ] 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 11, 2022
@release-please
chore(main): release 2.0.2 (#107)
67b7d53 
🤖 I have created a release *beep* *boop*
---


## [2.0.2](https://togithub.com/googleapis/nodejs-essential-contacts/compare/v2.0.1...v2.0.2) (2022-11-11)


### Bug Fixes

* Allow passing gax instance to client constructor ([#110](https://togithub.com/googleapis/nodejs-essential-contacts/issues/110)) ([fb3d596](https://togithub.com/googleapis/nodejs-essential-contacts/commit/fb3d596a8dee0ab338485a862955757cfbcd99c2))
* Better support for fallback mode ([#105](https://togithub.com/googleapis/nodejs-essential-contacts/issues/105)) ([c23259b](https://togithub.com/googleapis/nodejs-essential-contacts/commit/c23259b0a493e5bcdabf408902ffe16be76e7cb0))
* Change import long to require ([#106](https://togithub.com/googleapis/nodejs-essential-contacts/issues/106)) ([f009752](https://togithub.com/googleapis/nodejs-essential-contacts/commit/f009752ac7a8267ef6444fa9eb7338e70e6687d6))
* **deps:** Use google-gax v3.5.2 ([#117](https://togithub.com/googleapis/nodejs-essential-contacts/issues/117)) ([f90a6e7](https://togithub.com/googleapis/nodejs-essential-contacts/commit/f90a6e75af5c23754bf67bea1b8fd55c96a1330f))
* Do not import the whole google-gax from proto JS ([#1553](https://togithub.com/googleapis/nodejs-essential-contacts/issues/1553)) ([#109](https://togithub.com/googleapis/nodejs-essential-contacts/issues/109)) ([c7e8827](https://togithub.com/googleapis/nodejs-essential-contacts/commit/c7e8827859caa1c23bc38f43ca71cfe8d6784dfd))
* Preserve default values in x-goog-request-params header ([#111](https://togithub.com/googleapis/nodejs-essential-contacts/issues/111)) ([5074ba2](https://togithub.com/googleapis/nodejs-essential-contacts/commit/5074ba241d3e5ac5dc4a47ef7fc9cc3761f406cb))
* Regenerated protos JS and TS definitions ([#120](https://togithub.com/googleapis/nodejs-essential-contacts/issues/120)) ([4989df1](https://togithub.com/googleapis/nodejs-essential-contacts/commit/4989df17b1c7d0deb7907f7659b0fd2032833e8f))
* Remove pip install statements ([#1546](https://togithub.com/googleapis/nodejs-essential-contacts/issues/1546)) ([#108](https://togithub.com/googleapis/nodejs-essential-contacts/issues/108)) ([9fb4d1c](https://togithub.com/googleapis/nodejs-essential-contacts/commit/9fb4d1c253480086fe101cef0817874b313d076a))
* use google-gax v3.3.0 ([c7e8827](https://togithub.com/googleapis/nodejs-essential-contacts/commit/c7e8827859caa1c23bc38f43ca71cfe8d6784dfd))

---
This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).
sofisl added a commit that referenced this pull request Nov 11, 2022
@sofisl
build!: update library to use Node 12 (#108)
3f736b5 
*build!: Update library to use Node 12
Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
This was referenced Nov 11, 2022
Merged
Merged
sofisl pushed a commit that referenced this pull request Nov 16, 2022
@gcf-owl-bot
build: update copyright year to 2022 (#108)
a621ffa 
* chore(deps): upgrade gapic-generator-java to 2.4.1

PiperOrigin-RevId: 422607515

Source-Link: googleapis/googleapis@ba2ffd6

Source-Link: googleapis/googleapis-gen@73ba4ad
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNzNiYTRhZGQyMzlhNjE5ZGE1NjdmZmJkNGU1NzMwZmRkNmRlMDRkMyJ9

* 🦉 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 pushed a commit that referenced this pull request Nov 16, 2022
@bcoe
fix(deps): google-gax v2.17.1 (#108)
a006d3b
@sofisl sofisl mentioned this pull request Nov 16, 2022
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Nov 16, 2022
@release-please
chore: release 1.3.5 (#109)
5877f90 
🤖 I have created a release \*beep\* \*boop\*
---
### [1.3.5](https://www.github.com/googleapis/nodejs-bigquery-connection/compare/v1.3.4...v1.3.5) (2021-07-12)


### Bug Fixes

* **deps:** google-gax v2.17.1 ([#108](https://www.github.com/googleapis/nodejs-bigquery-connection/issues/108)) ([b94f6e6](https://www.github.com/googleapis/nodejs-bigquery-connection/commit/b94f6e69c6984ef5180f64e25eb5576d35471573))
---


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 16, 2022
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Nov 16, 2022
@release-please
chore: release 1.3.0 (#108)
55ed1b2 
🤖 I have created a release \*beep\* \*boop\*
---
## [1.3.0](https://www.github.com/googleapis/nodejs-retail/compare/v1.2.2...v1.3.0) (2021-10-19)


### Features

* add search mode to search request. If not specified, a single search request triggers both product search and faceted search. ([49b9b8e](https://www.github.com/googleapis/nodejs-retail/commit/49b9b8e22eba6318f54e44025df4e3c1900cb73e))
* update grpc service config settings to reflect correct API deadlines ([49b9b8e](https://www.github.com/googleapis/nodejs-retail/commit/49b9b8e22eba6318f54e44025df4e3c1900cb73e))
---


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 18, 2022
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Nov 18, 2022
@JustinBeckwith
build: ignore proto files in test coverage (#108)
afeadfa
@sofisl sofisl mentioned this pull request Jan 10, 2023
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Jan 10, 2023
@jkwlui
doc: add missing namespace (#108)
7f55fa6
@sofisl sofisl mentioned this pull request Jan 17, 2023
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Jan 17, 2023
@renovate @JustinBeckwith
chore(deps): lock file maintenance (#108)
0511a1d
sofisl pushed a commit that referenced this pull request Jan 24, 2023
@renovate @JustinBeckwith
chore(deps): lock file maintenance (#108)
b287296
sofisl pushed a commit that referenced this pull request Jan 25, 2023
@renovate @JustinBeckwith
chore(deps): lock file maintenance (#108)
012b2b3
@sofisl sofisl mentioned this pull request Sep 13, 2023
Closed
4 tasks
sofisl pushed a commit that referenced this pull request Sep 13, 2023
@JustinBeckwith
Release v0.1.3 (#108)
854b88f
@sofisl sofisl mentioned this pull request Sep 14, 2023
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Sep 14, 2023
@JustinBeckwith @alexander-fenster
Enable prefer-const in the eslint config (#108)
0ee5b3f
@sofisl sofisl mentioned this pull request Sep 14, 2023
Merged
4 tasks
This was referenced Nov 28, 2023
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@stephenplusplus @rakyll @beriberikix @silvolu