-
Notifications
You must be signed in to change notification settings - Fork 824
edit description for filename parameter in finfo-file.xml (php#4803) #4913
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
Open
vera-ju
wants to merge
1
commit into
php:master
Choose a base branch
from
vera-ju:improve_finfo_file_documentation
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should it not say URIs? Also, what is the source of this information?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To be completely honest, I'm not a PHP developer — I just came across this issue during Hacktoberfest.
From my point of view, there are three indicators that confirm this is correct:
The open issue states it very clearly: (Improve finfo_file documentation to state that the file must be local #4803)
“Suggested improvement: Clearly mention in the documentation that $filepath must be a local file and remote URLs are not accepted.”
I asked ChatGPT about it, and it confirmed the same.
A PHP colleague double-checked it and tested the function with an external URL — it didn’t work. However, using a local file worked correctly.
But if you don’t want to have it written that way in the documentation, feel free to just decline the PR.
Of course, I don’t want anything “incorrect” to be added either.
If you’d like, you can double-check it yourselves and adjust the wording however you think fits best 🙂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know why it doesn't work with remote files, because it does use streams. Perhaps someone else more knowledge can review this PR.