format

package module
v0.0.0-...-e62a8eb Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 28, 2019 License: MIT Imports: 1 Imported by: 0

README

fmt is bsclly t fmt pckg, bt splld crctly, wtht t AWL chrctrs, t ambgts, a t arcc ambnc.

It's a mx btwn a jk a a jb, a srvs as my plea t th glng comnty t qt trng t b clvr a trs a lrn t use cmplt wrds whn nmng stff. Nms r imprtnt. Cd is tpd 1 a rd hndrds o tms thrftr. It's wrth th xtra efrt in th end t b spcfc.


Translation:

format is basically the fmt package, but spelled correctly, without the AWOL characters, the ambiguities, and the archaic ambiance.

It's a mix between a joke and a jab, and serves as my plea to the golang community to quit trying to be clever and terse and learn to use complete words when naming stuff. Names are important. Code is typed once and read hundreds of times thereafter. It's worth the extra effort in the end to be specific.

Be a professional. Write complete names. Yes, you heard me: purposely cutting corners where spelling is concerned is unprofessional[1]. Don't hate me, just switch to an editor that provides auto-complete and commit to do better. You'll thank me later. GoLang is awesome. Let's be awesome gophers.

There, I said it. I feel better now. Thanks.


[1] Yes, of course there are (a few, and only a few) exceptions:

  • Single-letter variables used as counters in tightly scoped loops.
  • Well-defined acronyms from the field of computing and your specific problem domain.

That's about it. Oh, and maybe err. But every time you use it you should feel guilty for using a verb where a noun was called for...

Documentation

Overview

package format is basically the fmt package, but spelled correctly, without the AWOL characters, the ambiguities, and the archaic ambiance.

Index

Constants

This section is empty.

Variables

View Source
var (
	Error = fmt.Errorf

	Write       = fmt.Fprint
	WriteFormat = fmt.Fprintf
	WriteLine   = fmt.Fprintln

	Read       = fmt.Fscan
	ReadFormat = fmt.Fscanf
	ReadLine   = fmt.Fscanln

	Print       = fmt.Print
	PrintFormat = fmt.Printf
	PrintLine   = fmt.Println

	Scan       = fmt.Scan
	ScanFormat = fmt.Scanf
	ScanLine   = fmt.Scanln

	Compose       = fmt.Sprint
	ComposeFormat = fmt.Sprintf
	ComposeLine   = fmt.Sprintln

	Decompose       = fmt.Sscan
	DecomposeFormat = fmt.Sscanf
	DecomposeLine   = fmt.Sscanln
)

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL