docs(readme): explain emulator side effects #544
Conversation
Codecov Report
@@ Coverage Diff @@
## master #544 +/- ##
=======================================
Coverage 94.07% 94.07%
=======================================
Files 12 12
Lines 928 928
Branches 192 192
=======================================
Hits 873 873
Misses 44 44
Partials 11 11Continue to review full report at Codecov.
|
.readme-partials.yml
Outdated
| body: |- | ||
| ### Troubleshooting | ||
| #### Emulator returning `DEADLINE_EXCEEDED`, `java.lang.OutOfMemoryError` | ||
| *Reference Issue: https://github.com/googleapis/nodejs-datastore/issues/95* |
There was a problem hiding this comment.
it might be nice to make this a link:
*Reference Issue: [#95](https://github.com/googleapis/nodejs-datastore/issues/95)*
There was a problem hiding this comment.
Do you mean make the text “Reference Issue” a link rather than the issue number? This is a weird consistency micro-concern of an edge case where we have multiple reference links.
There was a problem hiding this comment.
Oh man, did my eyes trick me on this. Sorry, I'll make that change. What a goofball.
There was a problem hiding this comment.
I wasn't sure if GitHub linkifies links in READMEs, so was just thinking it's nice to have something clickable, we can confirm either way when we generate the README.
There was a problem hiding this comment.
Yeah, sorry, I thought you pasted the line the way I had it already, but you were actually writing out your suggestion. It was such a good suggestion, that I assumed I had already done it! 🤣
| *Reference Issue: https://github.com/googleapis/nodejs-datastore/issues/95* | ||
| When using the emulator, you may experience errors such as "DEADLINE_EXCEEDED" within your application, corresponding to an error in the emulator: "java.lang.OutOfMemoryError". These errors are unique to the emulator environment and will not persist in production. | ||
|
|
||
| A workaround is available, provided by [@ohmpatel1997](https://github.com/ohmpatel1997) [here](https://github.com/googleapis/nodejs-datastore/issues/95#issuecomment-554387312). |
There was a problem hiding this comment.
I'd be tempted to include the workaround here, explaining that you simply run Node.js with more memory; but with a link to the issue at the end of the line?
There was a problem hiding this comment.
I was tempted as well, although I didn't actually understand how to pass those arguments to the emulator. I figured the comment would make sense to emulator users, so I just linked. But if you know the full command to pass those, I will pop it in here!
README.md
Outdated
| @@ -85,7 +85,12 @@ async function quickstart() { | |||
| quickstart(); | |||
|
|
|||
| ``` | |||
| ### Troubleshooting | |||
| #### Emulator returning `DEADLINE_EXCEEDED`, `java.lang.OutOfMemoryError` | |||
| *Reference Issue: [#95](https://github.com/googleapis/nodejs-datastore/issues/95)** | |||
There was a problem hiding this comment.
I actually removed one, I was just going for italics.
.readme-partials.yml
Outdated
| body: |- | ||
| ### Troubleshooting | ||
| #### Emulator returning `DEADLINE_EXCEEDED`, `java.lang.OutOfMemoryError` | ||
| *Reference Issue: [#95](https://github.com/googleapis/nodejs-datastore/issues/95)** |
Fixes #95