Skip to content

[Dev] Docstrings assistant #335

@ocots

Description

@ocots

Make a docstrings assistant as a script, using AI. The idea would be to have a function

docstrings(;
    code="file_with_code.jl", # this file may contain docstrings to update and code without docstrings to add
    tests="file_with_unit_tests.jl", # optional
    doc="file_with_examples_of_docstrings.jl", # optional
)

that returns raw text containing the code with updated / added docstrings. The code must not be changed.

  • Could be great that this function would be written in Julia. Otherwise, some Python is ok.
  • The prompt to AI must be very precise.

Metadata

Metadata

Assignees

Labels

good first issueGood for newcomersinternal devModification to the code is requested and should not affect user experiment

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions