Fixes to reference doc generation #690
Conversation
laurenzlong
left a comment
laurenzlong
left a comment
There was a problem hiding this comment.
This is looking good!
export type CanonicalErrorCodeName can also be hidden.
src/providers/https.ts
Outdated
| rawRequest: Request; | ||
| } | ||
|
|
||
| // The allowed interface for an http request for a callable function. |
There was a problem hiding this comment.
I know we're hiding this, but just to document it better in the source code, can you revise this to:
The allowed interface for an HTTP request to a Callable function.
src/providers/https.ts
Outdated
| } | ||
|
|
||
| /** @hidden */ | ||
| // The format for the http body response to a callable function. |
There was a problem hiding this comment.
I know we're hiding this, but just to document it better in the source code, can you revise this to:
The format for an HTTP body response from a Callable function.
src/utilities/assertions.ts
Outdated
| @@ -1,3 +1,4 @@ | |||
| /** @hidden */ | |||
There was a problem hiding this comment.
I think this can be combined with the lines below to make one comment block:
/** @hidden
* @file Provides common assertion...
....
src/utilities/path.ts
Outdated
| @@ -1,3 +1,4 @@ | |||
| /** @hidden */ | |||
There was a problem hiding this comment.
I think this can be combined with the lines below to make one comment block
3 participants
Attempting a cleanup of our reference doc generation in these areas:
-- Adding home page content.
-- Hiding things to prevent unnecessary pages from being generated.
-- Hiding specific things to exclude them from generated pages.
-- Adding missing things such as a TOC entry for CallableContext.
Staged internally at: https://firebase.devsite.corp.google.com/docs/reference/functions/providers_https_
Thanks!