From 0967d4d9caa696bf42d25d1067658d0c2dfc96aa Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Stanis=C5=82aw=20G=C3=B3ra?= <stasgora@gmail.com>
Date: Sat, 10 Jul 2021 17:09:05 +0200
Subject: [PATCH] Prefix & docs tweaks

---
 example/simple.dart           | 10 +++++-----
 lib/round_spot.dart           | 12 ++++++------
 lib/src/entry_point.dart      |  2 +-
 lib/src/widgets/detector.dart |  4 +---
 4 files changed, 13 insertions(+), 15 deletions(-)

diff --git a/example/simple.dart b/example/simple.dart
index 0fa3861..1932dd4 100644
--- a/example/simple.dart
+++ b/example/simple.dart
@@ -2,12 +2,12 @@ import 'dart:io';
 
 import 'package:flutter/material.dart';
 import 'package:path_provider/path_provider.dart';
-import 'package:round_spot/round_spot.dart' as round_spot;
+import 'package:round_spot/round_spot.dart' as rs;
 
 void main() {
-  runApp(round_spot.initialize(
+  runApp(rs.initialize(
     child: ExampleApp(),
-    config: round_spot.Config(
+    config: rs.Config(
       uiElementSize: 12,
     ),
 	  localRenderCallback: (data, info) async {
@@ -22,7 +22,7 @@ class ExampleApp extends StatelessWidget {
   Widget build(BuildContext context) {
     return MaterialApp(
       title: 'Example Application',
-      navigatorObservers: [round_spot.Observer()],
+      navigatorObservers: [rs.Observer()],
       initialRoute: 'first',
       routes: {
         'first': (context) => Scaffold(
@@ -33,7 +33,7 @@ class ExampleApp extends StatelessWidget {
               ),
             ),
         'second': (context) => Scaffold(
-              body: round_spot.Detector(
+              body: rs.Detector(
                 areaID: 'list',
                 child: ListView(
                   children: [
diff --git a/lib/round_spot.dart b/lib/round_spot.dart
index fce8ed8..15a425a 100644
--- a/lib/round_spot.dart
+++ b/lib/round_spot.dart
@@ -6,7 +6,7 @@
 /// Wrap your [MaterialApp] widget to [initialize()] the library:
 /// ```dart
 /// void main() {
-///   runApp(round_spot.initialize(
+///   runApp(rs.initialize(
 ///     child: Application()
 ///   ));
 /// }
@@ -14,26 +14,26 @@
 /// Add an [Observer] for monitoring the navigator:
 /// ```dart
 /// MaterialApp(
-///   navigatorObservers: [ round_spot.Observer() ]
+///   navigatorObservers: [ rs.Observer() ]
 /// )
 /// ```
 ///
 /// ### Configuration
 /// Provide the callbacks for saving the processed output:
 /// ```dart
-/// round_spot.initialize(
+/// rs.initialize(
 ///   localRenderCallback: (data, info) => sendHeatMapImage(data)
 /// )
 /// ```
 /// Use [Config] to make the tool better fit your needs:
 /// ```dart
-/// round_spot.initialize(
-///   config: round_spot.Config(
+/// rs.initialize(
+///   config: rs.Config(
 ///     minSessionEventCount: 5,
 ///     uiElementSize: 15,
 ///     heatMapPixelRatio: 2.0,
 ///   ),
-///   loggingLevel: round_spot.LogLevel.warning // recommended for integration testing
+///   loggingLevel: rs.LogLevel.warning // recommended for integration testing
 /// )
 /// ```
 ///
diff --git a/lib/src/entry_point.dart b/lib/src/entry_point.dart
index 60a3d5b..d06aa75 100644
--- a/lib/src/entry_point.dart
+++ b/lib/src/entry_point.dart
@@ -30,7 +30,7 @@ typedef DataCallback = void Function(Uint8List data);
 /// Should be invoked in `main()` or otherwise wrap the [MaterialApp] widget:
 /// ```dart
 /// void main() {
-///   runApp(round_spot.initialize(
+///   runApp(rs.initialize(
 ///     child: Application()
 ///   ));
 /// }
diff --git a/lib/src/widgets/detector.dart b/lib/src/widgets/detector.dart
index a3b1810..cca6a2d 100644
--- a/lib/src/widgets/detector.dart
+++ b/lib/src/widgets/detector.dart
@@ -14,7 +14,7 @@ import '../utils/components.dart';
 /// To correctly monitor interactions with scrollable space a [Detector]
 /// has to be placed as a direct parent of that widget:
 /// ```dart
-/// round_spot.Detector(
+/// rs.Detector(
 ///   areaID: id,
 ///   child: ListView(
 ///     children: /* children */,
@@ -57,8 +57,6 @@ import '../utils/components.dart';
 /// will be included here in addition to the default screen maps.
 class Detector extends StatefulWidget {
   /// The widget below this widget to be observed.
-  ///
-  /// If you need to lay out multiple children in a column use [ListDetector].
   final Widget child;
 
   /// Consistently identifies the same visual region