Snorkell

What is Snorkell?

Snorkell is a smart AI tool designed to automatically create documentation, or docstrings, for all sorts of programming languages. It connects seamlessly with popular version control systems like GitHub, GitLab, and Bitbucket. This integration means it can automatically generate and update your docstrings every time a pull request is merged, keeping your documentation perfectly in sync with your code. Plus, Snorkel.ai lets you easily review the docstrings it generates and suggest any changes you think are needed, all through pull requests. You can choose from a free plan or paid options, which offer more support for your repositories, on-premise hosting, access to new experimental features, and support for languages like Python, Java, Kotlin, JavaScript, and TypeScript. What really sets Snorkel.ai apart is its focus on creating docstrings that are easy for people to read and understand, unlike older tools that might just produce technical, syntactic docstrings.

Who created Snorkell?

Snorkell.ai was developed by a team with deep roots in AI technology. The company officially launched Snorkell.ai on November 15, 2023. At its core, it’s an AI-powered tool that automatically generates documentation or docstrings for a variety of programming languages. It integrates with version control systems such as GitHub, GitLab, and Bitbucket, and it also allows users to review and suggest corrections for the auto-generated docstrings via pull requests. The tool comes in both free and paid versions, offering different levels of repository support and other benefits.

What is Snorkell used for?

• It automatically generates docstrings for many different programming languages.
• It connects with version control systems like GitHub, GitLab, and Bitbucket.
• It automatically updates docstrings whenever a pull request is merged.
• You can review and suggest changes to the auto-generated docstrings using pull requests.
• It supports a wide range of programming languages, including Python, Java, Kotlin, JavaScript, and TypeScript.
• It enhances security by generating docstrings dynamically without keeping your code on local storage.
• There are various pricing tiers available, each offering different features and support levels.
• The elite tier gives you access to experimental features and advanced AI models like GPT-4 and Mistral.
• On-premise support is an option if you choose the elite tier.
• It works with many programming languages, such as Python, Java, Kotlin, JavaScript, and TypeScript.

Who is Snorkell for?

• Software developers
• Programmers
• Documentation Specialists

How to use Snorkell?

Here’s how you can get started with Snorkel.ai:

1. Connect to Your Version Control System: First, Snorkel.ai needs to connect with your Git systems, like GitHub, GitLab, or Bitbucket.
2. Automatic Documentation Generation: Every time you merge a pull request, Snorkel.ai automatically creates and updates your docstrings, ensuring they always match your codebase.
3. Review and Correct Docstrings: You can easily review the docstrings Snorkel.ai generates and suggest any corrections through pull requests to make sure everything is accurate.
4. Choose Your Plan: Snorkel.ai offers both free and paid plans. The free plan lets you make 3 commits per day for private repositories and unlimited commits for public ones.
5. Language Support: It supports popular languages like Python, Java, Kotlin, JavaScript, and TypeScript.
6. Understand Feature Differences: Keep in mind that free plans have some limits on language support and repository access compared to the paid plans.
7. Explore the Elite Tier: If you opt for the elite tier, you’ll get on-premise support, access to advanced AI models like GPT-4, your own private GPT keys, experimental features, and 24/7 support.
8. Keep Your Code Secure: Snorkel.ai generates docstrings dynamically from the latest commit files, meaning it doesn’t store your code locally, which is great for security.
9. Human-Readable Docstrings: Snorkel.ai focuses on creating docstrings that are easy for people to read and understand in different languages, going beyond just the technical syntax.
10. Keep Documentation Synced: Docstrings are updated automatically with every pull request merge, so your documentation stays current.
11. Privacy First: To protect your data, Snorkel.ai doesn’t keep your code on local storage.
12. Try Experimental Features: Elite tier users can also get access to experimental features.

By following these steps, you can make the most of Snorkel.ai for efficient, automated documentation generation across various programming languages, all while benefiting from enhanced security and user-friendly features.