Tagging functions to be renamed

[jananiravi]

• Identify user-facing functions
• Identify non-conforming functions | _, . --> camelCase names
• Tag internal_use functions to start with .

[Seyi007]

On it

[Seyi007]

Hi @jananiravi, by tagging, do you mean noting down the function names to be changed? Or should the change be made by a contributor?

[jananiravi]

Yes, you can begin with documenting changes to be made by checking whether the current names follow typical good function nomenclature (e.g., style guide) and whether there's consistency across functions. If there's an agreement, changes can be made -- following confirmation from me or @the-mayer.

For instance,

• using camelCase instead of snake_case or function.names
• using descriptive verbs summarizeDomarch or plotLineages or something else | is the function name quickly telling you what it does?
• related issues [DOC] Function Inventory | add documentation w/ docstring #3 Create function dependency map #26

[Seyi007]

Noted, thanks!

[AleruDivine]

@jananiravi I wanted to ask if this issue is open for other applicants to contribute as well. I’m interested in getting involved.

[Seyi007]

Sure! @AleruDivine, I can help you get started and let you know how far I've gotten. it's a lot of function names haha.

[AleruDivine]

Oh! Thank you so much! I asked to work on another issue seeing you had already started working on this. I hoped to delete this comment. but yes please. I'd love to work on this together.

Let me delete my other comment 🥹

I'm just getting started, going through the resources. I'll reach out in a couple of hours.

Thank you so much!