Skip to content

Conversation

@inlined
Copy link
Member

@inlined inlined commented May 6, 2022

Modify docs for the root namespace. Some basic changes:

  • All fields are @beta
  • Params is no longer exported in index because it is not ready for use (if you want, I can just mark everything as @alph instead, but IDK if we can avoid documenting the namespace at all.
  • Constants are removed from options and instead are part of API comments
  • Literal string types now have inlined their definitions so that values are part of the API docs.

@inlined inlined changed the title Attempted fix; not sure why some things aren't showing up Update docs for root namespace May 9, 2022
@inlined inlined requested a review from colerogers May 9, 2022 17:53
Copy link
Contributor

@egilmorez egilmorez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few thoughts Thomas, thanks!

__endpoint: ManifestEndpoint;

/**
* The callback passed to the CloudFunction constructor.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is CloudFunction a literal?


/** A handler for CloudEvents. */
/**
* A handler for CloudEvents.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is "CloudEvents" a literal?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kinda? It's the name of a class, but it's also the name of a specification (which is what I intended here). The capitalization is what is at https://cloudevents.io

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough! :)

@inlined inlined merged commit 6709467 into master May 10, 2022
@inlined inlined deleted the inlined.docs.root branch May 10, 2022 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants