Skip to content

Commit

Permalink
polish
Browse files Browse the repository at this point in the history
  • Loading branch information
Clemapfel committed Aug 13, 2023
1 parent 397a7b1 commit e2a1798
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 11 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
---

Expand Down
14 changes: 8 additions & 6 deletions docs/src/01_manual/01_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions src/docgen/types.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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])
Expand Down
2 changes: 1 addition & 1 deletion src/mousetrap.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e2a1798

Please sign in to comment.