Skip to content

docs: Improve readability of headings for functions. #7869

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.

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

Conversation

MarkDuckworth
Copy link
Contributor

@MarkDuckworth MarkDuckworth commented Dec 13, 2023

Fixes b/316190402

One change to the Functions table at the top of the page:

  1. In function table, change function(param...) to function(param, ...)

Three changes to the function definitions at the bottom of the page:

  1. When function definitions are sorted by first param, add section headers within function definitions to show the logical groupings of functions.
  2. Add params to the function definition title, so readers can differentiate two adjacent headers
  3. Fix the heading level of the Exception node.

Function definitions was:

## foo()
### params: app, Field
## Exception If something something

## foo()
### params: app, string
## Exception If something something

## bar()
### params: app, ...

## baz()
### params: app

## foo()
### params: firestore, ...

Function definitions is now:

## function(app, ...)

### foo(app, Field)
#### params: app, Field
#### Exception If something something

### foo(app, string)
#### params: app, string
#### Exception If something something

### bar(app, ...)
#### params: app, ...

### baz(app)
#### params: app

## function(firestore, ...)

### foo(firestore)
#### params: firestore, ...

Copy link

changeset-bot bot commented Dec 13, 2023

⚠️ No Changeset found

Latest commit: 6300032

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@google-oss-bot
Copy link
Contributor

@google-oss-bot
Copy link
Contributor

@MarkDuckworth MarkDuckworth merged commit 7e46719 into markduckworth/documentation-links-for-function-overloads Dec 15, 2023
@MarkDuckworth MarkDuckworth deleted the markduckworth/documentation-function-heading-readability branch December 15, 2023 21:06
@firebase firebase locked and limited conversation to collaborators Jan 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants