Explorar o código

Documentation updates

arianagiroux hai 17 horas
pai
achega
6246216d12
Modificáronse 2 ficheiros con 2 adicións e 10 borrados
  1. 1 9
      Readme.md
  2. 1 1
      ping.go

+ 1 - 9
Readme.md

@@ -33,24 +33,16 @@ bubble := pingo.InitialPeakModel()
 
 ## Extras
 
- - [ ] Implement ssh TUI client (via wish)
  - [ ] Implement peak and average models (currently implemented: peak)
 
 ## resources
 
 | resource        | use                                |
 |-----------------|------------------------------------|
-| Core frameworks |                                    |
 | [bubbletea][bt] | TUI framework                      |
 | [lipgloss][lg]  | Terminal text formatting framework |
-|-----------------|------------------------------------|
-| TUI widgets     |                                    |
 | [bubbles][bbl]  | widget lib for bubbletea           |
 | [ntcharts][ntc] | chart widgets for bubbletea        |
-|-----------------|------------------------------------|
-| extras          |                                    |
-| [wish][wish]    | ssh tui client                     |
-|-----------------|------------------------------------|
 
 ### proposed color palette
 
@@ -60,7 +52,7 @@ bubble := pingo.InitialPeakModel()
 
 ## LICENSE
 
-All commuts are subject to the AGPL3
+All commits are subject to the AGPL3
 
 [bt]: https://github.com/charmbracelet/bubbletea
 [lg]: https://github.com/charmbracelet/lipgloss

+ 1 - 1
ping.go

@@ -36,7 +36,7 @@
 //		// append a ping to the Results slice, then return the updated slice
 //		a.Results, err = a.Poll()
 //		...
-//		// return a modified slice of only the most n*a.MaxResults long
+//		// return a modified slice of only the latest n*a.MaxResults results
 //		a.Results = a.Truncate()
 //
 // For more, see each function's GoDoc.