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 some minor inconsistencies in doc comments #163

Merged
merged 2 commits into from
Mar 11, 2024

Conversation

CompeyDev
Copy link
Contributor

@CompeyDev CompeyDev commented Mar 9, 2024

Fixes some minor issues in the current docs which are currently unclear, or incorrect.

Changes doc comments in the typedefs for the luau and fs libraries.

TODO: Replace "Luau" occurrences with "luau".

@CompeyDev
Copy link
Contributor Author

I feel like there should be an easier way to update the docs, without having to contribute to this repository directly; possibly a way to suggest changes?

Maybe it's a bit too complicated, but it would be nice if the typedef files (or just the doc comments) were synced to the docs repo and back. That way, one could just commit to the docs repo and it would reflect back here.

Copy link
Collaborator

@filiptibell filiptibell left a comment

Choose a reason for hiding this comment

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

Thanks for the fixes!

I feel like there should be an easier way to update the docs, without having to contribute to this repository directly; possibly a way to suggest changes?
Maybe it's a bit too complicated, but it would be nice if the typedef files (or just the doc comments) were synced to the docs repo and back. That way, one could just commit to the docs repo and it would reflect back here.

Typedefs and documentation being in this repository is intentional - they should live as close as possible to their respective source code so that it's harder to miss updating them when also updating behavior. I agree that the docs repo and pulling in changes there could be more automated though

@filiptibell filiptibell merged commit 20b9fce into lune-org:main Mar 11, 2024
4 of 5 checks passed
@CompeyDev
Copy link
Contributor Author

TODO: Replace "Luau" occurrences with "luau".

I think I forgot to actually finish this, mind pushing a commit yourself fixing this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants