Feedback

[cerveau23]

Type of issue

Missing information

Feedback

The setters are described as "representing X value". Was this doc automatically generated?!

Page URL

https://learn.microsoft.com/en-us/javascript/api/office-scripts/excelscript/excelscript.charttrendlinelabel?view=office-scripts#excelscript-excelscript-charttrendlinelabel-getautotext-member(1)

Content source URL

https://github.com/OfficeDev/office-scripts-docs-reference/blob/live/docs/docs-ref-autogen/excelscript/excelscript.charttrendlinelabel.yml

Author

@o365devx

Document Id

acd2da30-3028-fa6a-d5db-89f1f34d0ce6

Platform Id

d90cb702-8b66-4b9f-e890-cfcf7be1b22e

[AlexJerabek]

Hi @cerveau23,

Yes, the reference documentation for Office Scripts is automatically generated, though human-authored strings are the source material. I'll give you some technical details below, but we'll take your feedback that the current implementation looks sloppy. I'll tag @wandyezj for awareness.

So, all the reference documentation for Office Add-ins (Office.js) and Office Scripts is based on internal source files. Some tooling creates a type definition (.d.ts) file for Office.js. The Office Scripts API is a version of Office.js that has been transpiled to be synchronous. As part of this, properties (like ChartTrendline.Label.autoText are converted to get/set methods. The reference string is kept the same to avoid introducing grammar issues. I'm sure it's possible to convert the text when creating get/set methods to change the all-purpose "Represents" or "Specifies" into "Gets" or "Sets", though I can't speak to the relative priority of the work.