microsoft / MixedReality-UXTools-Unreal

UX tools and components for developing Mixed Reality applications in UE4.
https://microsoft.github.io/MixedReality-UXTools-Unreal/
MIT License
316 stars 86 forks source link

Fixed typos in the Documentation #28

Open SilasContaifer opened 3 years ago

SilasContaifer commented 3 years ago

I saw that inside the scripts like in UxtHandConstraintComponent.h we refer to the component as **UU**xtHandConstraintComponent but when a user uses Unreal do insert this component, they cannot search for anything that starts with the UUx... as for them each component will be find it with their name starting with Uxt (e.g. Uxt Hand Constraint).

So I propose this changes removing the double U in this three files in the documentation, I confirm that that is no other citation of a component starting with UUxt in the other .md in this Docs folder.

ghost commented 3 years ago

CLA assistant check
All CLA requirements met.

luis-valverde-ms commented 3 years ago

Thanks a lot @SilasContaifer . I'm running it through the team to make sure we standardize the way we write type names in docs. My vote goes for what you propose (skip type prefix, at least in actors and components). Once we reach a decision, I'll update you here, implement the changes in the internal repo and push them to GitHub.