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

Fix incomplete description for ResourceLoader.list_directory() #104006

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

Conversation

Wierdox
Copy link
Contributor

@Wierdox Wierdox commented Mar 12, 2025

Description of ResourceLoader.list_directory() is bad.

  • Doesn't say it includes directories. The fact it just says "returning all resources contained within" implies it only includes files that are resources.
  • The way it appends / at the end of directories isn't in common with DirAccess(it's just the folder name), which seems like an inconsistency... but regardless it should be mentioned.
  • Doesn't say it's sorted alphabetically.
  • Should probably refer to DirAccess as the standard way of interacting with the filesystem.

My edit should cover the bases.

@Wierdox Wierdox requested a review from a team as a code owner March 12, 2025 00:55
@AThousandShips AThousandShips added enhancement documentation cherrypick:4.4 Considered for cherry-picking into a future 4.4.x release labels Mar 12, 2025
@AThousandShips AThousandShips added this to the 4.x milestone Mar 12, 2025
@Wierdox Wierdox force-pushed the fix_incomplete_description_for_list_directory branch from 43b4a4d to 8828aab Compare March 21, 2025 08:16
@Wierdox
Copy link
Contributor Author

Wierdox commented Mar 21, 2025

Initially a two word clarification, I increased the scope of my PR since I realized I missed some stuff. Of what I did, I can see one arguing that the codeblock example or the DirAccess reference being a step too far. Guess I'll find out.

@Wierdox Wierdox force-pushed the fix_incomplete_description_for_list_directory branch from 8828aab to 7958402 Compare March 21, 2025 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherrypick:4.4 Considered for cherry-picking into a future 4.4.x release documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants