Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

accept multiple lines description #155

Merged
merged 1 commit into from Feb 3, 2022
Merged

accept multiple lines description #155

merged 1 commit into from Feb 3, 2022

Conversation

shogo82148
Copy link
Owner

Writing multi-line descriptions is common, but indentation by go fmt is not good.

Some examples:

	func() {
		Description(`Lorem ipsum dolor sit amet,consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris
nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur.
Excepteur sint occaecat cupidatat non proident,
sunt in culpa qui officia deserunt mollit anim id est laborum.`)
}
	func() {
		Description("Lorem ipsum dolor sit amet,consectetur adipiscing elit,\n" +
			"sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n" +
			"Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris\n" +
			"nisi ut aliquip ex ea commodo consequat.\n" +
			"Duis aute irure dolor in reprehenderit in voluptate velit esse\n" +
			"cillum dolore eu fugiat nulla pariatur.\n" +
			"Excepteur sint occaecat cupidatat non proident,\n" +
			"sunt in culpa qui officia deserunt mollit anim id est laborum.")
	}
	func() {
		Description(
			"Lorem ipsum dolor sit amet,consectetur adipiscing elit,\n" +
				"sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\n" +
				"Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris\n" +
				"nisi ut aliquip ex ea commodo consequat.\n" +
				"Duis aute irure dolor in reprehenderit in voluptate velit esse\n" +
				"cillum dolore eu fugiat nulla pariatur.\n" +
				"Excepteur sint occaecat cupidatat non proident,\n" +
				"sunt in culpa qui officia deserunt mollit anim id est laborum.",
		)
	}

If the Description function accepts multiple arguments, we can write these code as the following:

	func() {
		Description(
			"Lorem ipsum dolor sit amet,consectetur adipiscing elit,",
			"sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
			"Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris",
			"nisi ut aliquip ex ea commodo consequat.",
			"Duis aute irure dolor in reprehenderit in voluptate velit esse",
			"cillum dolore eu fugiat nulla pariatur.",
			"Excepteur sint occaecat cupidatat non proident,",
			"sunt in culpa qui officia deserunt mollit anim id est laborum.",
		)
	}

I think it is pretty nice. How do you think?

@shogo82148 shogo82148 merged commit 8a04ba3 into main Feb 3, 2022
@shogo82148 shogo82148 deleted the enhance-description branch February 3, 2022 06:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant