Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

Move user-facing information to top of preferences #613

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Move user-facing information to top of preferences #613

wants to merge 1 commit into from

Conversation

TimMonko
Copy link
Contributor

@TimMonko TimMonko commented Mar 3, 2025

References and relevant issues

Description

  1. Moves user-facing information to the top of the autogenterated preferences document.
  2. Removes the redundant programmatic settings code block (unless we also want to show the settings.SETTINGS version. I think as a learner, understanding how get_settings() is used to set a singleton was more important to my understanding)

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 3, 2025
willingc
willingc approved these changes Mar 3, 2025
View reviewed changes
Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @TimMonko for another user-centered improvement. I love the user "how-to" before the preferences reference section. 💐

# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@willingc willingc willingc approved these changes

At least 1 approving review is required to merge this pull request.

Assignees

@TimMonko TimMonko

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@TimMonko @willingc