Hello

When running on python scripts, got "language not supported". Script type is well detected by vscode as python.
Version of vscode : 1.65.2
AI Doc Writer : 2.0.6
Thks

Lionel

I can see that typescript types work from the loom demo video, but when I try on typescript interfaces, it doesn't provide any information on the properties, and just says /* Defining the interface for the ... */

Also, for this common syntax:

const ComponentName = (props: ComponentNameProps) => {

it just generates /* A React component that is responsible for ... */. It'd be useful to actually be able to delve into those props and generate useful documentation for it.

I would be nice to get support for version 1.60.x of vscode.

Regards

Hi guys! Do you have plans about ruby, rust and swift support? This extension is so helpful, thank u!

Where or what do i edit to make it use the name

The extension currently requires the user to select a piece of code, and "Ctrl+", it to write the documentation. Is there any way to automate this process for the whole VSCode project ? That would allow to generate the entire documentation for an existing project in seconds..

Looks like API host is down.

Will you support also numpy style in the future for python? https://numpydoc.readthedocs.io/en/latest/format.html

O have a few questions about the project, some of them could even go on the readme to clarify things for others as well.

1 - How much of the code is sent to the server when genereating a doc? (Only the selected code, the entire file/class, the entire project, the chain of methods called ?)

2 - Are these information sen't to sever ONLY when the function "Write Docs" is called or there is some data being sent periodically?

3 - What is the API called to generate these docs, a open source one? A private one?

The extension is generating remarkably informative text. But, oddly, none of the generated text is commented:

Language c++. Happens in in headers and cpp files. OS: Windows 10, VSCode 1.68.1

The output looks like this:

protected:
    A function that is called when the button is drawn.
    void draw_self() override;

Hi all,

is there any option to set lowercase for doc added?

thanks

Do you offer Turkish language support?

Please provide a plugin for Android Studio soon.

currently the @return does not hint at what is being returned.

     * @return The hash of the input string.
     */

even if the function itself states what is returned

: string

this can confuse some markup displays

I would like it to grab the type being returned

* @return string The hash of the input string.

as part of the creation

It's very annoying me that extension in vscode shows Generate Docs everytime.

Could you make a option to hide this hover tips?

Hi! 👋 First of all, love your extension!

Secondly, I noticed recently that even though Javascript is a supported language, the extension is confused by *.vue files and refuses to document JS code within <script> tags.

I presume it's the same for other frameworks that mix JS, CSS and HTML in the same file.

Mintlify is great project! But it doesn't seem to be able to handle .cc files. Wish it will support it

Hi Team,

I found my user level settings "workbench.colorCustomizations" is always overridden by project's folder or workspace level setting when vscode launches a project which .vscode/settings.json has custom "workbench.colorCustomizations"

Once I disabled this extension, no same problem was happened.

extension version: v2.1.22
vscode version: 1.67.2

It's my first time using this extension, and I'm impressed by how well it works.

I wrote a function to help generate complex class names in JavaScript. The project uses React, so I have states to dynamically generate the classes for my elements. It gave me everything I need, but I noticed the@returns tag in the JSDoc explains the function again.

This is what it returns

/**
 * It takes an array of strings, arrays, and objects, and returns a string of all the truthy values
 * @param {CX[]} args - CX[]
 * @returns A function that takes in an array of strings and returns a string of class names.
 */

So I just trimmed the text to use a string of class names. alone.

Here are the function and types

export function cx(...args: CX[]) {
  const classes = args.reduce<Array<string | string[]>>((acc, cur) => {
    let item: string | string[] = [];

    if (!cur) return acc;

    if (typeof cur === "string") item = cur;
    else if (Array.isArray(cur)) item = (cur[0] ? cur[1] : cur[2]) ?? [];
    else item = Object.keys(Object.fromEntries(Object.entries(cur ?? {}).filter((i) => i[1])));

    return item ? [...acc, item] : acc;
  }, []);

  return [...new Set(classes.flat())].join(" ").replace(/\s{2,}/g, " ");
}

type CX = undefined | null | false | string | [unknown, string, string?] | Record<string, unknown>;

This is a really good extension and I'm already happy with how it works. Thanks for your effort

{dashboard}/api/login/vscode

I user VSCodium.
The extension requires to sign in.
When I try to sign in, I get an error:
unauthorized_client: Callback URL mismatch. https://mintlify.com/start/vscodium is not in the list of allowed callback URLs

The URL called is
https://mintlify.us.auth0.com/authorize?response_type=code&client_id=MOMiBZylQGPE0nHpbvzVHAT4TgU0DtcP&redirect_uri=https://mintlify.com/start/vscodium&scope=openid%20profile%20email%20offline_access#

When opening VSCode, this extension adds "http.systemCertificates": false to the user settings.

There's a reason why system certificates are a thing, and bypassing them puts the system at risk. Anyone using this extension should immediately uninstall it and restore their http.systemCertificates setting.

• https://en.wikipedia.org/wiki/Certificate_authority

heey guys,
While generating doc we catch an error:

when we go to GsonFormatPlus plugin page, on their readme we can read info like this

so i switched to intellij, installed your plug again and it just works fine

Sometimes the docs creating docs like:

    # Getting the platform and name of the host from the Nornir inventory.
    platform = nr.inventory.hosts[f"{task.host}"].platform
    device_name = nr.inventory.hosts[f"{task.host}"].name

    # Creating a naming object.
    defs = naming.Naming(DEF_DIR)

It would be great to have an option which allowed only singular present tense to be used for example:

    # Get the platform and name of the host from the Nornir inventory.
    platform = nr.inventory.hosts[f"{task.host}"].platform
    device_name = nr.inventory.hosts[f"{task.host}"].name

    # Create a naming object.
    defs = naming.Naming(DEF_DIR)

Is there an option for this or is this something that could be added.

Many Thanks,

An exported function simply gets a descriptive comment:

/* Adding a transaction to the database. */
exports.addTransaction = async (data) => {
   try {
      return await db.addDoc({ collection: 'transactions', data })
   } catch (error) {
      console.error(error)
      return false
   }
}

If I don't directly export the function I get a JsDoc result:

/**
 * It takes in a data object, and then it returns the result of the db.addDoc function, which is either
 * true or false
 * @param data - The data to be added to the database.
 * @returns The return value of the function is the return value of the db.addDoc function.
 */
const addTransaction = async (data) => {
   try {
      return await db.addDoc({ collection: 'transactions', data })
   } catch (error) {
      console.error(error)
      return false
   }
}

I just heard about this plugin on Medium. I'm very excited to see this because it will definitely save me a TON of time! Thank you so much!!! 👍🏻

Would you add a new type of doc for php specifically laravel.

https://swagger.io/

Here is an example in a php file.

https://github.com/zircote/swagger-php/blob/master/Examples/example-object/OpenApiSpec.php

There are no attempts to integrate this into AI yet so it would be a big plus to cover it with yours.

Here is a article of it being used in a laravel api written in php.

https://blog.quickadminpanel.com/laravel-api-documentation-with-openapiswagger/

Or is there a way to edit the template your phpstorm plugin uses and so I can add these to it.

/**
 * @OA\Tag(
 *     name="user",
 *     description="User related operations"
 * )
 * @OA\Info(
 *     version="1.0",
 *     title="Example for response examples value",
 *     description="Example info",
 *     @OA\Contact(name="Swagger API Team")
 * )
 * @OA\Server(
 *     url="https://example.localhost",
 *     description="API server"
 * )
 */
class OpenApiSpec {}

Dart support

Do you have plans about C# and .NET support?

Are you planning on supporting VB.NET and if so, when?
This is our primary programming language at our company.

Thanks

The default doxygen style is as follows for C++.

 /**
 * It returns the index of the binding with the given name
 * 
 * @param name The name of the binding to get the index of.
 * 
 * @return The index of the binding.
 */

How can I change it to the following style?

//!
//! \brief It returns the index of the binding with the given name.
//!
//! \param[in] name The name of the binding to get the index of.
//!
//! \return The index of the binding.
//!

Bonjour,

First I would like to thank you for this wonderful tool, it saves me a lot of time.

However, I have a request. In VSCode you can modify the "Keyboard Shortcuts". So I changed the shortcut from "Ctrl+." to "Ctrl+Shift+," since it conflicts with "editor.action.quickFix" (as suggested in this reply). But the extension still tells me to use the default hotkey. It should show me the new keyboard shortcut.

Currently:

What should be displayed:

On linux I can't set up hotkeys, because only options available are '⌘ + .' and '⌥ + .', which I don't have on keyboard.

Before used the extension I doesn't have errors in my code but when I execute the extension I have a problem idk why.

Can you help me please?
I think maybe he gets dizzy at times

Hey guys,

Firstly, thank you very much for this amazing extension. I was trying google docstring format for a code of mine and it doesn't seem to detect args correctly

Example:

def try_utf8(data: bytes) -> bool:
    '''
    If you pass a bytes object to this function, it will return True if it can be decoded as UTF-8, and
    False if it cannot.
    
    Args:
      None
    
    Returns:
      A boolean value.
    '''
    try:
        data.decode('utf-8')
        return True
    except UnicodeDecodeError:
        _logger.info('Not utf-8 encoding')
        return False

Also, just wanted to point out the official google docstring format: https://gist.github.com/redlotus/3bc387c2591e3e908c9b63b97b11d24e#file-docstrings-py-L46

Cheers!

In the latest version of vs code 1.65.2 I get the error message 'Unable to create configurations at the moment' in the lower right when I start vs code.
All extensions were disabled and config.json is clean.

Would love to see PowerShell added to the supported languages for this.

Hi
I tried to install the extention. I can't did it because the installer say to me:
Cannot be installed the extention "mintlify.document" beacuse isn't compatibble the actual VS Code version (version 1.61.2)

What do version I need to have installed?

Thanks

Visual Studio code prints following message when I try to use the AI doc writer for any function:
Error occured while generating docs

Even for simple python functions like:
def test(): print("Hello World!")

System specs:
Windows 10 Enterprise Build 21H1
Visual Studio Code Version 1.63.2
AI Doc Writer v1.5.1 (Last updated on 24.1.2022, 22:45:04)

I have been using AI Doc writer for a couple weeks now and I definitely prefer it over other Auto Doc extensions. However it does not give good documentation and/or useless weird documentation.
I have some pretty big react components and it was giving a good description of the Component (but failing half the time to put it in JSDoc format) But this week when I have tried using it on some components and it will just leave a /* Yes. */ or something else minimal and useless or /* That is it. */

Edit: I think this issue for me is mostly related to my use of Mobx and Mobx-react. A lot of components are wrapped with a observer()

Python documentation is always inserted after the first line and not in the correct position.
This can be a problem especially when using popular formatting tools such as black.
For example:

def sample_function(
    value: int,
    text: str
):
    return value + 1

Would be inserted incorrectly.

This is happening on MacOS12 with Apple M1 chip in VSCode.

Hi Team,
Can we use mintlify for Java in Intellij Idea or VS code?

I don't see where i can change the default docstring format when using PyCharm.

Thank you.

Hi, first of all. Thank you for the project!
It really looks pretty well.

Do you know if it will be possible to add other languages like: spanish?

Thanks in advance.

Mintlify seems to detect the language from the file extension.
But some languages are not restricted to a single extension.

For example:

• cpp is correctly detected for the .cpp file extension...
• ... but other acceptable file extensions for c++ are not recognized:
  • Source files: .c++, .cc and .cxx.
  • Header files: .h++, .hh, .hxx and .hpp
  • https://stackoverflow.com/questions/5171502/c-vs-cc-vs-cpp-vs-hpp-vs-h-vs-cxx mentions additional, less common extensions (.ii, .ixx, .ipp, .inl for inline definitions, .txx, .tpp and .tpl for templates...)

It would be great if those extensions were supported.
(Or if additional custom extension/language associations could be added in the settings).

Hello, I am using Python 3.9.7 on Windows and it says lang not supported? When I expand the lang section it is also empty, why?

Hey, the extension looks great! 😊
I saw you're making a request to your server with the vscode provided machineId as identifier. I couldn't find any information about your privacy policy or more information on how the code is used or if it's saved on your servers at all. Could you provide a link to your privacy policy and preferably also put the link into the page of the marketplace?

Hi,

is it possible to add the support for svelte? your extension is very useful

no button appear in the box

vscode + os informations

Version: 1.66.2
Commit: dfd34e8260c270da74b5c2d86d61aee4b6d56977
Date: 2022-04-11T07:49:24.808Z
Electron: 17.2.0
Chromium: 98.0.4758.109
Node.js: 16.13.0
V8: 9.8.177.11-electron.0
OS: Linux x64 5.17.4-100.fc34.x86_64

What i tried

• uninstall vscode
• uninstall the extension
• remove everything in ~/.vscode and ~/.config/Code

it work great on my macbook and windows, i can't remember if it worked on my fedora system