-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
add named parameters and correct types for some natives #1204
base: master
Are you sure you want to change the base?
Conversation
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.
Also overall I don't think you need to prefix each parameter with a letter representing the type of the parameter as the types are described in the native documentation anyway.
Yes you need to that. This is call having a signature structure in the code. Also, instead of spamming the same review comment for everything, please only make one. This is not a good way to review something. |
Apologies regarding the repetition comments, still new to this GitHub mobile app and just now figured out I can I select multiple lines. As for the prefixing, it doesn't seem to be the standard across other exiting natives. I suppose where I'm getting confused is why is it required, yet not something being enforced across the repo from what I'm seeing right now. |
There's a mismatch of naming scheme all across the native list, using |
Gotcha, thank you for that input. With that said, considering what you wrote regarding the benefits for Lua and JS, perhaps we could explore the idea of adding a standard for parameter names to the contributor guidelines for PRs moving forward? |
I personally don't care either way, prefix or not. I figured for completions sake i'd use the name as its defined, however i do agree that this is not the standard across other native documentations. Let me know and i'll adjust them either way.
@JayPaulinCodes i added as much documentation as i was able to provide, figured i would still push it even if its just the parameters being renamed. A bit of progress is better than none was my thought. |
@coalaura How did you find the names for the params again? |
anchient sourcery and witchcraft |
My train of thought was that if we had enough knowledge to find a accurate name for the param, I feel like we would have enough to give the parameter some form of description, but if that isn't the case so be it. |
The issue is more with my limited knowledge of c++. I try to figure out what it does as best as i can in some cases its above my head tho. I will go through one more time and try to add documentation where i can :) Edit: Went through all the natives i changed one more time and updated the documentation as best as i could. |
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.
Initial review, only looked at types will review in more detail later.
Co-authored-by: Dillon Skaggs <dillskaggs@gmail.com>
Co-authored-by: Dillon Skaggs <dillskaggs@gmail.com>
No description provided.