Skip to content

It would be nice if comments were added to methods for intellisense  #252

Open
@chanced

Description

@chanced

Since the API is generated, I doubt this would be too big of a lift. Basically what I'm suggesting is adding comments on the fields of the structs themselves.

So instead of this:
Screen Shot 2021-04-20 at 2 36 20 PM
Adding the comments inline, such as:

// Indices contains the Indices APIs
type Indices struct {
	AddBlock              IndicesAddBlock
	Analyze               IndicesAnalyze
	ClearCache            IndicesClearCache
	Clone                 IndicesClone
	Close                 IndicesClose
	CreateDataStream      IndicesCreateDataStream
	// Creates an index with optional settings and mappings.
	//
	// See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html.
	//
	Create                IndicesCreate

would yield:
Screen Shot 2021-04-20 at 2 41 32 PM

Thank you for the package, by the way.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions