Skip to content

Repo Documentation #96

Description

@davidaquilue

After testing out the repo with the GEC pipeline and the linear Hopf model, I believe that improving the documentation of the repository would greatly help new users and could help extend its reach and use.

I am testing out some AI-assisted software development tools (mainly Claude Code) which could help with repository documentation. I don't know your stance on AI-assisted development @neich @dagush @ajunca, would you be open to consider a repository-wide documentation enhancement through these tools?

If yes, do you have a specific documentation style you'd like to follow consistently? I see some functions/classes have docstrings with NumPy style documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions