Comments in typescript class definition are wrong

[AntCas]

Describe the bug Descriptive comments are wrong in /asyncairtable/lib/asyncAirtable.d.ts, appear to be offset.

Examples:

The description for the "find" function described the "createRecord" function.

find: (table: string, id: string) => Promise<AirtableRecord>;
    /**
     * Creates a new record on the specified table.

The description for the "createRecord" function described the "updateRecord" function.

 createRecord: (table: string, record: Fields, typecast?: boolean | undefined) => Promise<AirtableRecord>;
    /**
     * Updates a record on the specified table.

etc. etc.

 updateRecord: (table: string, record: AirtableUpdateRecord, opts?: updateOpts | undefined) => Promise<AirtableRecord>;
    /**
     * Deletes a record from the specified table.

Screenshots

[AntCas]

The comments appear to be correct in asyncAirtable.ts, and I think this class file is generated. So the problem might be with whatever library is generating the typscript class definition and not with this repo. Regardless, figured I'd make the problem visible here and attempt to fix. Didn't figure out a fix.

[seanmetzgar]

Sorry about that. These comments feed the documentation API. They precede the corresponding function instead of follow.

-Sean

On Thu, Jul 15, 2021 at 14:40 Anthony Castrio @.***> wrote:

Describe the bug Descriptive comments are wrong in /asyncairtable/lib/asyncAirtable.d.ts, appear to be offset.

Examples:

The description for the "find" function described the "createRecord" function.

find: (table: string, id: string) => Promise; /**

• Creates a new record on the specified table.

The description for the "createRecord" function described the "updateRecord" function.

createRecord: (table: string, record: Fields, typecast?: boolean | undefined) => Promise; /**

• Updates a record on the specified table.

etc. etc.

updateRecord: (table: string, record: AirtableUpdateRecord, opts?: updateOpts | undefined) => Promise; /**

• Deletes a record from the specified table.

Screenshots [image: Screen Shot 2021-07-15 at 1 38 05 PM] https://user-images.githubusercontent.com/6935841/125840027-5439fadb-bd6e-448f-bc28-6909e46ef267.png

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/GV14982/async-airtable/issues/71, or unsubscribe https://github.com/notifications/unsubscribe-auth/AABMRGHGYZZDTSGBNTXOT7LTX4TS7ANCNFSM5AODJVNQ .

--

Sean Metzgar

[GV14982]

Hi there, Sean is correct. The definition comments precede the function or object they are describing.

[AntCas]

Ah okay, I was just reading it wrong then. My bad, thanks for the clarification :)