Document how actors are displayed#2792
Open
cycsmail wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes:
Datasette uses
display_actor()to choose a short label for the current actor in places like the navigation menu and the/-/logoutpage, but that behaviour wasn't documented anywhere. This adds a "How actors are displayed" section to the authentication docs that spells out thedisplay/name/username/login/idkey order it looks through and thestr(actor)fallback when none are set.I also added a test in
tests/test_docs.pythat reads the key tuple straight fromdisplay_actorand asserts each key is mentioned in the new docs section, so the docs and the code can't quietly drift apart. The test_docs.py tests pass, and the new test fails if the docs section is removed.