docs: Add multi-language inline docs page

[vikram-dagger]

No description provided.

[vikram-dagger]

I had some difficulty with this page, as the Python examples were different from the others. I have tried to make them all consistent now, but even so differences persist (see inline comments) and the snippets should be reviewed again.

Flagging this for re-review for each code snippet @kpenfound @helderco @TomChv

[vikram-dagger]

The Python output differs from that of the Go and TypeScript ones.

• For Go and TypeScript, the inline comments for object/struct properties appear in the output of dagger functions but not in the flag list of dagger call --help
• For Python, the inline comments appear as flags in dagger call --help but not in the output of dagger functions

[vikram-dagger]

I'm guessing there is a fix needed to my code snippets, but I'm not sure what it is.

[helderco]

Those are different things. dagger functions only show the available functions from selected object. It doesn't show arguments and that includes the constructor of course. It also doesn't show the description of the object that you're currently viewing, but dagger call --help should. So stick to --help as it shows all three:

• Main object's name and description and constructor arguments
• Currently selected function and description and available arguments
• Available functions to chain

[helderco]

I'm guessing there is a fix needed to my code snippets, but I'm not sure what it is.

I'll comment inline what I can notice just by the diff for now.

[helderco]

Deploy preview failed, so I'm rebasing from the web to get it built.

[helderco]

Ok, should have checked the error. Looks like reference docs are failing.

[helderco]

@vikram-dagger, let me know when the preview is fixed. And to ask you to update the outputs from --help based on latest dagger version. 🙏

[helderco]

The constructor's arguments aren't documented so their flags won't show the descriptions.

[vikram-dagger]

This didn't work. Am I doing something wrong?

package main

// The struct represents a single user of the system.
type MyModule struct {
	// The name of the user.
	Name string
	// The age of the user.
	Age int
}

func New(name string, age int) *MyModule {
	return &MyModule{
		// The name of the user.
		Name: name,
		// The age of the user.
		Age: age,
	}
}

FUNCTIONS
  age           The age of the user.
  name          The name of the user.

ARGUMENTS
      --age int       [required]
      --name string   [required]

[vikram-dagger]

Done

[helderco]

Constructor arguments here also not documented, that's why their flags don't show the descriptions.

[vikram-dagger]

This also didn't work with the code below

import { object, field, func } from "@dagger.io/dagger"

/**
 * The object represents a single user of the system.
 */
@object()
class MyModule {
  /**
   * The name of the user.
   */
  @field()
  name: string

  /**
   * The age of the user.
   */
  @field()
  age: number

  constructor(age: number, name: string) {
    // The name of the user.
    this.name = name
    // The age of the user.
    this.age = age
  }
}

FUNCTIONS
  age           The age of the user.
  name          The name of the user.

ARGUMENTS
      --age int       [required]
      --name string   [required]

[TomChv]

You need to document the code following JsDoc convention with /** **/ comment

[vikram-dagger]

Done

[vikram-dagger]

@vikram-dagger, let me know when the preview is fixed. And to ask you to update the outputs from --help based on latest dagger version. 🙏

Preview is fixed. --help output fixed for first example. Still not able to get the second one to display the descriptions properly, see my inline replies with code and output.

[TomChv]

I reviewed the TS code and answered to your doc question.

The reason why we do not support // is because the TS compiler API doesn't consider them as comment.
It only include JSDoc style comment.