Merged

Conversation

Merged

Comment on lines +203 to +208

		Author attribution
		==================

		For new documentation, do not use a byline (naming the author of the document).
		Explicit attribution tends to discourage other users from updating community
		documentation.

Comment on lines +214 to +218

		First-person language
		=====================

		Avoid first-person language. Our documentation is owned and maintained by a
		community. First-person language mistakenly implies a single author.

Member

Would it be nicer to phrase this positively, saying something like:

Suggested change

	First-person language
	=====================

	Avoid first-person language. Our documentation is owned and maintained by a
	community. First-person language mistakenly implies a single author.
	Grammatical person
	==================

	We try to maintain a consistent tone of voice across our documentation.
	As part of this, prefer using the third-person when writing reference text and either the second or third person when writing tutorials or guides, which are naturally more 'interactive'.

This removes the negative language from the text, and additionally provides better guide rails for authors of different types of text.

AA-Turner changed the title ~~move style guide recommendations into devguide~~ Add further recommendations to the style guide

Comment on lines +203 to +208

		Author attribution
		==================

		For new documentation, do not use a byline (naming the author of the document).
		Explicit attribution tends to discourage other users from updating community
		documentation.

Comment on lines +203 to +208

		Author attribution
		==================

		For new documentation, do not use a byline (naming the author of the document).
		Explicit attribution tends to discourage other users from updating community
		documentation.

nedbat deleted the nedbat/style-guide-updates branch

nedbat added a commit to python/editorial-board that referenced this pull request

None yet