Snorkell.ai

FAQ from Snorkell.ai

What is Snorkell.ai?

Snorkell.ai automatically generates and updates your GitHub project docstring whenever a pull request is merged, ensuring your docstring is always current with your codebase.

What is the difference between Snorkell.ai and PyDoc?

PyDoc is for Python only and can only generate Syntactic Docstring while Snorkell.ai generates human-readable and understandable docstring for languages like - Python, JavaScript, TypeScript, Java, and Kotlin.

What programming languages are currently supported by Snorkell.ai for generating docstring?

Snorkell.ai currently provides support for the following programming languages: Python, JavaScript, TypeScript, Java, and Kotlin.

Does Snorkell.ai retain the code on a local server in order to generate the docstring?

No, Snorkell.ai does not retain your code on local storage. Contrary to tools like Sonar, it retrieves the latest commit files and dynamically creates the docstring, maintaining the security of your code within your GitHub repository.

How does Snorkell.ai handle inaccuracies in the automatically generated docstring?

If the docstring produced by Snorkell.ai contains errors, users can review and suggest corrections through the generated pull request before it is merged. This ensures that any inaccuracies can be resolved, and the docstring remains accurate and reliable.