You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Pass "link summaries" instead of "resolved information" in external documentation source responses
Description
Continuing the work from #468; the OutOfProcessReferenceResolver/Response includes OutOfProcessReferenceResolver/ResolvedInformation values which lose some information that's available in LinkDestinationSummary (for example the resolved information abstract in plain text and loses any formatting or links that was in the original abstract). We should update OutOfProcessReferenceResolver to support passing LinkDestinationSummary values and phase out OutOfProcessReferenceResolver/ResolvedInformation
Motivation
There are two main motivations for this change:
Not losing information in the content of external pages
Avoiding code duplication; OutOfProcessReferenceResolver/ResolvedInformation needs to be kept up to date whenever there are changes to the LinkDestinationSummary data.
Importance
This change will allow formatting and links in external page's abstracts to be preserved.
Alternatives Considered
We could add additional fields to OutOfProcessReferenceResolver/ResolvedInformation for any information that it currently loses compared to LinkDestinationSummary which would give both types the same capabilities but that would make the code duplication and maintenance worse than if we only had one type for this.
The text was updated successfully, but these errors were encountered:
Feature Name
Pass "link summaries" instead of "resolved information" in external documentation source responses
Description
Continuing the work from #468; the
OutOfProcessReferenceResolver/Response
includesOutOfProcessReferenceResolver/ResolvedInformation
values which lose some information that's available inLinkDestinationSummary
(for example the resolved information abstract in plain text and loses any formatting or links that was in the original abstract). We should updateOutOfProcessReferenceResolver
to support passingLinkDestinationSummary
values and phase outOutOfProcessReferenceResolver/ResolvedInformation
Motivation
There are two main motivations for this change:
OutOfProcessReferenceResolver/ResolvedInformation
needs to be kept up to date whenever there are changes to theLinkDestinationSummary
data.Importance
This change will allow formatting and links in external page's abstracts to be preserved.
Alternatives Considered
We could add additional fields to
OutOfProcessReferenceResolver/ResolvedInformation
for any information that it currently loses compared toLinkDestinationSummary
which would give both types the same capabilities but that would make the code duplication and maintenance worse than if we only had one type for this.The text was updated successfully, but these errors were encountered: