taipy icon indicating copy to clipboard operation
taipy copied to clipboard

[DOCS] Consistency in function and method docstrings

Open jrobinAV opened this issue 1 year ago • 20 comments

Issue Description

Function and method parameters are documented using either Parameters, Arguments, or Args keywords. We should only use Arguments everywhere.

Code of Conduct

  • [x] I have checked the existing issues.
  • [ ] I am willing to work on this issue (optional)

jrobinAV avatar Oct 08 '24 15:10 jrobinAV

@jrobinAV can i take up the issue ?

Tushar98644 avatar Oct 08 '24 15:10 Tushar98644

@jrobinAV would like to work on this , could you assign this to me?

wizaye avatar Oct 08 '24 15:10 wizaye

@Tushar98644 @wizaye I have assigned this issue to both of you! Thank you for your contribution!

FlorianJacta avatar Oct 08 '24 16:10 FlorianJacta

@FlorianJacta I've made a PR with the necessary changes. please check it ;)

wizaye avatar Oct 08 '24 16:10 wizaye

Is this issue still open

Harish-2003 avatar Oct 08 '24 17:10 Harish-2003

@Harish-2003 its open but we're working on it kindly check other issues for time being

wizaye avatar Oct 08 '24 17:10 wizaye

@Harish-2003 its open but we're working on it kindly check other issues for time being

Sure

Harish-2003 avatar Oct 08 '24 17:10 Harish-2003

@trgiangdo @FlorianJacta i had a issue with the branch while updating the previous pr, i've opened a new one #1973 with the requested changes, please look into it

wizaye avatar Oct 08 '24 18:10 wizaye

I would like to work on this.

afrinashar avatar Oct 08 '24 19:10 afrinashar

@wizaye is already working on it and created a PR on this issue. But I can also assign you if you want to collaborate.

FlorianJacta avatar Oct 09 '24 12:10 FlorianJacta

How do I take up an issue?

margaret-hu avatar Oct 09 '24 15:10 margaret-hu

@margaret-hu someone from the team assigns it to you and then you work on it and make a valid PR

wizaye avatar Oct 09 '24 15:10 wizaye

Can I assist with this issue as well?

margaret-hu avatar Oct 09 '24 15:10 margaret-hu

@margaret-hu yes you can , wait until someone from the team assigns the issue to you. We're currently working on the issue with an ongoing PR you can check that as well.

wizaye avatar Oct 09 '24 15:10 wizaye

@margaret-hu Thank you for your help. You are assigned as well.

jrobinAV avatar Oct 09 '24 18:10 jrobinAV

How do I directly contribute to an issue?

margaret-hu avatar Oct 10 '24 01:10 margaret-hu

i do like to take on this issue please assign it to me!

DevyManish avatar Oct 10 '24 19:10 DevyManish

I would like to work on this project. Please assign it to me .

Sushil2k4 avatar Oct 11 '24 07:10 Sushil2k4

@Sushil2k4 and @margaret-hu, look up the PR created for this issue. You can either collaborate on it or create your own PR that you think improve it

FlorianJacta avatar Oct 11 '24 08:10 FlorianJacta

@FlorianJacta Sorry for the delay, but I’ve submitted a PR with the required changes. Please take a look when you can! PR #2046

DevyManish avatar Oct 14 '24 08:10 DevyManish

@jrobinAV can i take up this issue ?

coddingjatin avatar Oct 17 '24 11:10 coddingjatin

This issue has been resolved by #2046

jrobinAV avatar Oct 30 '24 14:10 jrobinAV