OfficeDev / office-js-docs

[ARCHIVED] Microsoft Office Add-ins API Reference Documentation
https://docs.microsoft.com/javascript/api/overview/office
398 stars 247 forks source link

suspendApiCalculationUntilNextSync example code doesn't use suspendApiCalculationUntilNextSync #1469

Closed evantrimboli closed 6 years ago

evantrimboli commented 6 years ago

Article URL

https://github.com/OfficeDev/office-js-docs/blob/master/reference/excel/application.md

Issue

In the example code section for suspendApiCalculationUntilNextSync, it demonstrates loading the calculationMode.

Rick-Kirkham commented 6 years ago

@evantrimboli This misunderstanding has come up before. It is a side effect of the formatting of our API reference articles.

The section "Property access examples" is a peer of the calculate and suspendApiCalculationUntilNextSync sections. It is not a subsection of the suspendApiCalculationUntilNextSync section. The "Property access examples" section gives code examples of reading/writing to properties of the class. In this case, the application class has only one property, so there is only one example in the section. There is no code example in the suspendApiCalculationUntilNextSync section.

Within the next few weeks we will switch to a new API reference system where this shouldn't happen anymore.