Skip to content

Commit

Permalink
docs: missing sentences
Browse files Browse the repository at this point in the history
Close #1471
  • Loading branch information
posva committed Dec 4, 2023
1 parent 64308fb commit 1e2c71e
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
3 changes: 2 additions & 1 deletion src/firestore/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ export function useCollection<T>(
export interface UseDocumentOptions extends _UseFirestoreRefOptions {}

/**
* Creates a reactive document from a document ref from Firestore. Extracts the type of the converter
* Creates a reactive document from a document ref from Firestore. Automatically extracts the type of the converter or
* the document.
*
* @param documentRef - document reference
* @param options - optional options
Expand Down
2 changes: 1 addition & 1 deletion src/firestore/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import { _FirestoreRefOptionsWithDefaults } from './bind'
export type FirestoreReference = Query | DocumentReference | CollectionReference

/**
* Default converter for Firestore data. Can be overridden by setting the
* Default converter for Firestore data. Can be overridden globally by setting `globalFirestoreOptions.converter`.
*/
export const firestoreDefaultConverter: FirestoreDataConverter<VueFirestoreDocumentData> =
{
Expand Down

0 comments on commit 1e2c71e

Please sign in to comment.