GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — Function signatures should use slash/star as needed by nedbat · Pull Request #1344 · python/devguide

Function signatures should use slash/star as needed #1344

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

Merged

willingc merged 2 commits into python:main from nedbat:nedbat/slash-star

Jul 12, 2024

Uh oh!

There was an error while loading. Please reload this page.

Merged

Function signatures should use slash/star as needed #1344

Changes from all commits

Commits

Show all changes

2 commits

Select commit Hold shift + click to select a range

672ceb9

Function signatures should use slash/star as needed

nedbat Jul 2, 2024

da1b11a

explain more about the reason to use slash/star

nedbat Jul 11, 2024

File filter

Filter by extension .rst (1) All 1 file type selected

Viewed files

Clear filters

Conversations

Failed to load comments.

Uh oh!

There was an error while loading. Please reload this page.

Jump to

Jump to file

Failed to load files.

Uh oh!

There was an error while loading. Please reload this page.

Diff view

Unified

Split

Hide whitespace

Diff view

Unified

Split

Hide whitespace

There are no files selected for viewing

16 changes: 16 additions & 0 deletions 16 documentation/style-guide.rst

Show comments

View file

Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -99,6 +99,7 @@ such as "for example" or "that is."


		.. index:: diataxis
		.. _diataxis:

		Diátaxis
		========
Expand Down Expand Up		@@ -291,3 +292,18 @@ errors ("I made a mistake, therefore the docs must be wrong ..."). Typically,
		the documentation wasn't consulted until after the error was made. It is
		unfortunate, but typically no documentation edit would have saved the user from
		making false assumptions about the language ("I was surprised by ...").

		Function signatures
		===================

		These are the evolving guidelines for how to include function signatures in the
		reference guide. As outlined in :ref:`diataxis`, reference material should
		prioritize precision and completeness.

		- If a function accepts positional-only or keyword-only arguments, include the
		slash and the star in the signature as appropriate::

		.. function:: some_function(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):

		Although the syntax is terse, it is precise about the allowable ways to call
		the function and is taken from Python itself.

Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.