From e2a17986644ecf86b2e8c121624b4bca9030f611 Mon Sep 17 00:00:00 2001 From: clem Date: Sun, 13 Aug 2023 16:26:03 +0200 Subject: [PATCH] polish --- README.md | 2 +- docs/src/01_manual/01_installation.md | 14 ++++++++------ src/docgen/types.jl | 6 +++--- src/mousetrap.jl | 2 +- 4 files changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 945d397..814d9c8 100644 --- a/README.md +++ b/README.md @@ -157,7 +157,7 @@ Where all four packages need to be installed, regardless of the operating system Installation may take a long time. Once mousetrap is installed and precompilation is done, it can be loaded in only a few seconds during regular usage. -> **Note**: On Windows, some `GLib` log messages regarding dbus connections may appear during testing. These do not indicate a problem, as long as at the end of the testing suite it says `mousetrap tests passed`. +> **Note**: On Windows, some `GLib` log messages regarding dbus connections and may appear during testing. These do not indicate a problem, as long as at the end of the testing suite it says `mousetrap tests passed`. --- diff --git a/docs/src/01_manual/01_installation.md b/docs/src/01_manual/01_installation.md index c5a2398..08b0b78 100644 --- a/docs/src/01_manual/01_installation.md +++ b/docs/src/01_manual/01_installation.md @@ -9,16 +9,18 @@ In this chapter, we will learn: ## Installation -Installation of the Julia component is only a few lines. After pressing `]` while in the REPL to enter Pkg mode, we enter: +Installation of the Julia component is only a few lines. In the REPL, we enter: ``` -add https://github.com/Clemapfel/mousetrap_windows_jll -add https://github.com/Clemapfel/mousetrap_linux_jll -add https://github.com/Clemapfel/mousetrap_apple_jll -add https://github.com/Clemapfel/mousetrap.jl +import Pkg +Pkg.add(url="https://github.com/Clemapfel/mousetrap_windows_jll") +Pkg.add(url="https://github.com/Clemapfel/mousetrap_linux_jll") +Pkg.add(url="https://github.com/Clemapfel/mousetrap_apple_jll") +Pkg.add(url="https://github.com/Clemapfel/mousetrap.jl") +Pkg.test("mousetrap") ``` -We can make sure everything works by calling `test mousetrap`, while still in Pkg mode. +This may take a long time. If installation was succesfull, `mousetrap tests passed` will be printed. ## Hello World diff --git a/src/docgen/types.jl b/src/docgen/types.jl index a7e5c5f..e9ac152 100644 --- a/src/docgen/types.jl +++ b/src/docgen/types.jl @@ -514,7 +514,7 @@ set_widget!(column, 4, Label("4")) @document DragEventController """ # DragEventController <: SingleClickGesture <: EventController -Event controller that recogizes drag-gestures by both a mouse or touch-device. +Event controller that recogizes drag-gestures by both a mouse or touch device. $(@type_constructors( DragEventController() @@ -1234,7 +1234,7 @@ $(@type_fields( @document LongPressEventController """ # LongPressEventController <: SingleClickGesture <: EventController -Event controller that recognizes long-press-gestures from a mouse or touch-device. +Event controller that recognizes long-press-gestures from a mouse or touch device. $(@type_constructors( LongPressEventController() @@ -1873,7 +1873,7 @@ end @document ScrollEventController """ # ScrollEventController <: EventController -Controller recognizing scrolling gestures, such as a mouse scrollwheel or 2-finger touch-screen scrolling. +Controller recognizing scrolling gestures by a mouse scrollwheel or touch device. $(@type_constructors( ScrollEventController([kinetic_scrolling_enabled::Bool = false]) diff --git a/src/mousetrap.jl b/src/mousetrap.jl index 61685e2..e8de45e 100644 --- a/src/mousetrap.jl +++ b/src/mousetrap.jl @@ -1605,7 +1605,7 @@ const VERSION = v"0.1.0" return wait(schedule(task)) end export main - + Base.show(io::IO, x::Application) = show_aux(io, x, :is_holding, :is_marked_as_busy) ####### window.jl