Skip to content

Commit

Permalink
Update and add package synopsis for where useful (#1137)
Browse files Browse the repository at this point in the history
This commit adds useful package synopsis to packages for displaying a description on for example pkg.go.dev.
It also updated a couple existing ones and some spelling mistakes in the code.
  • Loading branch information
Jacalz committed Jun 26, 2020
1 parent 2c280e7 commit ebb8181
Show file tree
Hide file tree
Showing 12 changed files with 13 additions and 9 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Expand Up @@ -34,7 +34,7 @@ More detailed release notes can be found on the [releases page](https://github.c
* Apps started on a goroutine will now panic as this is not supported
* On Linux apps now simulate 120DPI instead of 96DPI
* Improved fyne_settings scale picking user interface
* Reorganised fyne_demo to accomodate growing collection of widgets and containers
* Reorganised fyne_demo to accommodate growing collection of widgets and containers
* Rendering now happens on a different thread to events for more consistent drawing
* Improved text selection on mobile devices

Expand Down
2 changes: 1 addition & 1 deletion cmd/fyne_demo/main.go
@@ -1,4 +1,4 @@
// Package main provides various examples of Fyne API capabilities
// Package main provides various examples of Fyne API capabilities.
package main

import (
Expand Down
2 changes: 1 addition & 1 deletion cmd/hello/main.go
@@ -1,4 +1,4 @@
// Package main loads a very basic Hello World graphical application
// Package main loads a very basic Hello World graphical application.
package main

import (
Expand Down
2 changes: 1 addition & 1 deletion dialog/base.go
@@ -1,4 +1,4 @@
// Package dialog defines standard dialog windows for application GUIs
// Package dialog defines standard dialog windows for application GUIs.
package dialog // import "fyne.io/fyne/dialog"

import (
Expand Down
1 change: 1 addition & 0 deletions driver/desktop/driver.go
@@ -1,3 +1,4 @@
// Package desktop provides desktop specific driver functionality.
package desktop

import "fyne.io/fyne"
Expand Down
1 change: 1 addition & 0 deletions driver/mobile/device.go
@@ -1,3 +1,4 @@
// Package mobile provides mobile specific driver functionality.
package mobile

// Device describes functionality only available on mobile
Expand Down
1 change: 1 addition & 0 deletions storage/file.go
@@ -1,3 +1,4 @@
// Package storage provides storage access and management functionality.
package storage

import (
Expand Down
1 change: 1 addition & 0 deletions tools/playground/playground.go
@@ -1,3 +1,4 @@
// Package playground provides tooling for running fyne applications inside the Go playground.
package playground

import (
Expand Down
4 changes: 2 additions & 2 deletions widget/menu_internal_test.go
Expand Up @@ -38,7 +38,7 @@ func TestMenu_ItemTapped(t *testing.T) {
test.Tap(mi2)
assert.True(t, tapped)
assert.True(t, dismissed, "tap on item dismisses the menu")
assert.True(t, m.Visible(), "tap on item does not hide the menu … OnDismiss is reponsible for that")
assert.True(t, m.Visible(), "tap on item does not hide the menu … OnDismiss is responsible for that")

dismissed = false // reset
mi3.MouseIn(nil)
Expand All @@ -49,7 +49,7 @@ func TestMenu_ItemTapped(t *testing.T) {

test.Tap(smi)
assert.True(t, dismissed, "tap on sub item dismisses the root menu")
assert.True(t, m.Visible(), "tap on item does not hide the menu … OnDismiss is reponsible for that")
assert.True(t, m.Visible(), "tap on item does not hide the menu … OnDismiss is responsible for that")
assert.False(t, sm.Visible(), "tap on sub item hides the sub menu")

newActionTapped := false
Expand Down
2 changes: 1 addition & 1 deletion widget/splitcontainer.go
Expand Up @@ -33,7 +33,7 @@ func NewVSplitContainer(top, bottom fyne.CanvasObject) *SplitContainer {

func newSplitContainer(horizontal bool, leading, trailing fyne.CanvasObject) *SplitContainer {
s := &SplitContainer{
Offset: 0.5, // Sensible default, can be overriden with SetOffset
Offset: 0.5, // Sensible default, can be overridden with SetOffset
Horizontal: horizontal,
Leading: leading,
Trailing: trailing,
Expand Down
2 changes: 1 addition & 1 deletion widget/text_test.go
Expand Up @@ -303,7 +303,7 @@ func TestText_splitLines(t *testing.T) {
},
},
{
name: "Muliple_Trailing",
name: "Multiple_Trailing",
text: "foo\nbar\n",
want: [][2]int{
{0, 3},
Expand Down
2 changes: 1 addition & 1 deletion widget/textgrid.go
Expand Up @@ -24,7 +24,7 @@ var (
TextGridStyleWhitespace TextGridStyle
)

// define the types seperately to the var definition so the custom style API is not leaked in their instances.
// define the types separately to the var definition so the custom style API is not leaked in their instances.
func init() {
TextGridStyleDefault = &CustomTextGridStyle{}
TextGridStyleWhitespace = &CustomTextGridStyle{FGColor: theme.ButtonColor()}
Expand Down

0 comments on commit ebb8181

Please sign in to comment.