Documentation icon indicating copy to clipboard operation
Documentation copied to clipboard

Add assembly and namespace information to classes

Open Ceron257 opened this issue 4 years ago • 3 comments

It would be super nice to add information about the assembly and namespace to find classes in. For example for GameMenu: Assembly:

Mount & Blade II Bannerlord\bin\Win64_Shipping_Client\TaleWorlds.CampaignSystem.dll

Namespace:

TaleWorlds.CampaignSystem.GameMenus

This could help beginners to actually use the documentation way better.

Ceron257 avatar Apr 10 '20 08:04 Ceron257

Is this something you would add to the sub-sections themselves (for example GameMenu) or at the root (README)?

I think at the root / table of contents level it could get tight. @Ster-Z waht dou you think?

highstreeto avatar Apr 12 '20 11:04 highstreeto

Though, adding these information to the sub-sections themselves is redundant, I'd still go for that, as the information is more present there to the ones seeking it.

I believe that at least.

Ceron257 avatar Apr 12 '20 15:04 Ceron257

I'll keep this in mind while migrating the docs. I'm not sure if this will be added/enforced though. I think I need to restructure some of the docs based on a proper format.

strlngd avatar Apr 15 '20 17:04 strlngd