Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Apparently crefs to other than Libplanet.dll are not resolved #2182

Closed
moreal opened this issue Jul 29, 2022 · 6 comments
Closed

Apparently crefs to other than Libplanet.dll are not resolved #2182

moreal opened this issue Jul 29, 2022 · 6 comments
Labels
bug Something isn't working docs Related to documentation

Comments

@moreal
Copy link
Contributor

moreal commented Jul 29, 2022

When you see the part of the document, you can see the exceptions' link like InvalidOperationException or KeyNotFoundException.

Examples

  1. IAccountStateDelta (docs, code)
  2. IStore.PruneOutdatedChains (docs, code)
@moreal moreal added bug Something isn't working docs Related to documentation labels Jul 29, 2022
@longfin
Copy link
Member

longfin commented Jul 29, 2022

@moreal Could you give more detailed info or the screen capture about the symptom you said? (I couldn't get the point 😅 )

@tkiapril
Copy link
Contributor

I think it's that on the XML there is a reference to exceptions:
image
but once it's compiled it vanishes:
image
(notice the lack of KeyNotFoundException)

@moreal
Copy link
Contributor Author

moreal commented Jul 29, 2022

That's what I mean, if the title made you confused, it should be corrected 😓

@OnedgeLee
Copy link
Contributor

Since our document does not have referenced exception type, it cannot be seen on document.
It would be better to use tag, or link MS official document.

@tkiapril
Copy link
Contributor

This may have occurred due to a MSBuild bug, refer dotnet/docfx#8097 and dotnet/msbuild#7832. Not sure if it's suitable as a good first issue. 🤔

@dahlia dahlia changed the title Libplanet API docs seem broken in part Apparently crefs to other than Libplanet.dll are not resolved Sep 7, 2022
@stale
Copy link

stale bot commented Jan 8, 2023

This issue has been automatically marked as stale because it has not had recent activity. Thank you for your contributions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs Related to documentation
Projects
No open projects
Status: Done
Development

No branches or pull requests

5 participants