search

AIHawk-FOSS / Auto_Jobs_Applier_AI_Agent

Auto_Jobs_Applier_AI_Agent by AIHawk is an AI Agent that automates the jobs application process. Utilizing artificial intelligence, it enables users to apply for multiple jobs in an automated and personalized way.
GNU Affero General Public License v3.0
22.43k stars 3.31k forks source link

[DOCS]: Code Docs - Happy to Contribute #694

Open SebGSX opened 3 weeks ago

SebGSX commented 3 weeks ago

Affected documentation section

Code is missing """Docs"""

Documentation improvement description

I'm working through the project to make use of it and noticed that a bunch of the code could use some docs. It's not glamorous work, but it does help folks orient themselves. Since I'm going through the code, I'd be happy to provide docs. All I need is guidance on any specific requirements for the docs, if any.

Why is this change necessary?

Better docs speed up adoption, change, and bugfix--also gets better output from coding assistants.

Additional context

No response

FrancescoVassalli commented 2 weeks ago

https://github.com/feder-cr/Auto_Jobs_Applier_AIHawk/tree/release/v11.01.2024/docs

SebGSX commented 2 weeks ago

Here is what I get when I click that link:

image

Is that your way of saying, yes to my offer?

Also, by code docs I mean class, method, and function documentation.

FrancescoVassalli commented 2 weeks ago

No sorry the link was updated. Here you go

https://github.com/AIHawk-app/Auto_Jobs_Applier/tree/main/docs

Tgenz1213 commented 1 day ago

No sorry the link was updated. Here you go

https://github.com/AIHawk-app/Auto_Jobs_Applier/tree/main/docs

This is not relevant to what is being asked. They asking for docstrings