[Docs] Add some notes about native file dialog limitations. #94161
Conversation
This file contains 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
Mickeon
reviewed
Jul 10, 2024
doc/classes/FileDialog.xml
Outdated
| </member> | ||
| <member name="current_dir" type="String" setter="set_current_dir" getter="get_current_dir"> | ||
| The current working directory of the file dialog. | ||
| [b]Note:[/b] This property might be ignored by native file dialogs. |
There was a problem hiding this comment.
This note is way too broad and, from the reader's point of view, it's meaningless. If anything, it implies the property is unreliable and you shouldn't use it.
There was a problem hiding this comment.
it implies the property is unreliable and you shouldn't use it.
It is unreliable.
For the reference, description for the underlying native implementation docs:
Suggested folder from which the files should be opened.
The portal implementation is free to ignore this option.
There was a problem hiding this comment.
It's worth briefly explaining why that's the case, then, instead of leaving the reader on its own thoughts.
akien-mga
approved these changes
Jul 17, 2024
AThousandShips
approved these changes
Jul 22, 2024
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.