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.

Sign up for GitHub

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

Jump to bottom

[BUG] file_chmod documentation not updated #675

Open
social-anthrax opened this issue Feb 11, 2025 · 3 comments · May be fixed by #676
Open

[BUG] file_chmod documentation not updated #675

social-anthrax opened this issue Feb 11, 2025 · 3 comments · May be fixed by #676
Labels
bug Something isn't working stdlib

Comments

@social-anthrax
Copy link

Describe the bug
Docs for file_chmod are incorrect. Current docs state "Sets a file as executable". This does not reflect the behaviour of the function.

Expected behavior
This line in the documentation should be removed, as the function expects a mode string, and does not provide a default.

pub fun file_chmod(path: Text, mode: Text): Bool

Additional context
https://docs.amber-lang.com/stdlib/doc/fs#file_chmod
@social-anthrax social-anthrax added the bug Something isn't working label Feb 11, 2025
@github-project-automation github-project-automation bot moved this to 🆕 New in Amber Project Feb 11, 2025
@social-anthrax
Copy link
Author

Happy to fix this myself if this is a valid bug.

@Mte90 Mte90 changed the title [BUG] [BUG] file_chmod documentation not updated Feb 11, 2025
@Mte90 Mte90 added the stdlib label Feb 11, 2025
@Mte90
Copy link
Member

Mte90 commented Feb 11, 2025

It is a valid bug, we changed the behaviour of that function recently and we forgot to update the doc.
You can do a PR to the stdlib to fix it :-)

@social-anthrax social-anthrax linked a pull request Feb 11, 2025 that will close this issue
Open
@social-anthrax
Copy link
Author

Opened a PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working stdlib
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix doc string for file_chmod social-anthrax/amber
2 participants
@Mte90 @social-anthrax