From 7f83898d00eced8603b85b1c18b3eaa267cfabc7 Mon Sep 17 00:00:00 2001 From: micimize Date: Sun, 4 Apr 2021 11:12:48 -0500 Subject: [PATCH] normalize example methods based on docs elsewhere --- docs/pages/docs/Getting started/writing_queries.md | 4 ++-- .../src/runtime/query_builder/statements/query.dart | 11 +++++------ 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/pages/docs/Getting started/writing_queries.md b/docs/pages/docs/Getting started/writing_queries.md index 0bcc24c1..7abaa32c 100644 --- a/docs/pages/docs/Getting started/writing_queries.md +++ b/docs/pages/docs/Getting started/writing_queries.md @@ -107,11 +107,11 @@ MultiSelectable pageOfTodos(int page, {int pageSize = 10}) { } // Exposes `getSingle` and `watchSingle` -SingleSelectable todoById(int id) => +SingleSelectable entryById(int id) => select(todos)..where((t) => t.id.equals(id)); // Exposes `getSingleOrNull` and `watchSingleOrNull` -SingleOrNullSelectable todoFromExternalLink(int id) => +SingleOrNullSelectable entryFromExternalLink(int id) => select(todos)..where((t) => t.id.equals(id)); ``` These base classes don't have query-building or `map` methods, signaling to the consumer diff --git a/moor/lib/src/runtime/query_builder/statements/query.dart b/moor/lib/src/runtime/query_builder/statements/query.dart index 7197b182..5253c95d 100644 --- a/moor/lib/src/runtime/query_builder/statements/query.dart +++ b/moor/lib/src/runtime/query_builder/statements/query.dart @@ -104,9 +104,8 @@ abstract class MultiSelectable { /// {@template moor_single_selectable_example} /// ```dart /// // Retrieve a todo known to exist. -/// SingleSelectable entryById(int id) { -/// return (select(todos)..where((t) => t.id.equals(id))); -/// } +/// SingleSelectable entryById(int id) => +/// select(todos)..where((t) => t.id.equals(id)); /// final idGuaranteedToExist = 10; /// entryById(idGuaranteedToExist).getSingle(); /// entryById(idGuaranteedToExist).watchSingle(); @@ -161,12 +160,12 @@ abstract class SingleSelectable { /// {@template moor_single_or_null_selectable_example} ///```dart /// // Retrieve a todo from an external link that may not be valid. -/// SingleOrNullSelectable todoFromExternalLink(int id) => +/// SingleOrNullSelectable entryFromExternalLink(int id) => /// select(todos)..where((t) => t.id.equals(id)); /// /// final idFromEmailLink = 100; -/// todoFromExternalLink(idFromEmailLink).getSingleOrNull(); -/// todoFromExternalLink(idFromEmailLink).watchSingleOrNull(); +/// entryFromExternalLink(idFromEmailLink).getSingleOrNull(); +/// entryFromExternalLink(idFromEmailLink).watchSingleOrNull(); /// ``` /// {@endtemplate} ///