iTwin / itwinjs-core

Monorepo for iTwin.js Library
https://www.itwinjs.org
MIT License
600 stars 210 forks source link

Multi-sentence property docs are truncated on at least one page #7051

Closed pmconne closed 4 weeks ago

pmconne commented 1 month ago

Describe the bug For a property with documentation comment exceeding one sentence, only the first sentence is accessible via the deployed docs site. The property shows as a link, but clicking it does not reveal the rest of the sentences in the documentation comment.

To Reproduce Steps to reproduce the behavior:

  1. Got to https://www.itwinjs.org/reference/core-backend/imodelhost/imodelhostoptions/
  2. Observe maxTileCacheDbSize displays the first sentence of its doc comment.
  3. Click on it maxTileCacheDbSize link.

Expected behavior Clicking the link takes me to a dedicated page containing the full documentation for that property.

Actual behavior Clicking the link takes me to https://www.itwinjs.org/reference/core-backend/imodelhost/imodelhostoptions/#maxtilecachedbsize which is the same page I'm on and reveals no more information.

Screenshots image

Desktop (please complete the applicable information):

Additional context Same behavior is observed with all other property links on the IModelHostOptions doc page. The links on other pages, like IModelHost, appear to function as expected.

ben-polinsky commented 1 month ago

Thanks, I'll take a look

ben-polinsky commented 4 weeks ago

Bug related to how we parse interface members. Fixed.

https://www.itwinjs.org/reference/core-backend/imodelhost/imodelhostoptions/ (might have to hard refresh) https://www.itwinjs.org/reference/core-backend/imodelhost/imodelhostoptions/maxtilecachedbsize/