route-recognizer API is not documented

aurelia / documentation

The documentation for Aurelia.

MIT License

105 stars 111 forks source link

route-recognizer API is not documented #354

Closed gheoan closed 6 years ago

gheoan commented 6 years ago

I'm submitting a feature request

Current behavior: Aurelia HUB does not include the route-recognizer library.

Expected/desired behavior:

What is the expected behavior? Aurelia HUB should include the route-recognizer library.
What is the motivation / use case for changing the behavior? Inspecting the API without looking at the source code.

Alexander-Taran commented 6 years ago

@EisenbergEffect is it an oversight? I can see some of the modules in route-recognizer have comments with type info.

EisenbergEffect commented 6 years ago

I think we thought of this as more of an "internal" module. We hadn't had many use cases where people want or need to interact with it directly. In a future version of Aurelia, I think this might just get merged with the router itself.

Alexander-Taran commented 6 years ago

@EisenbergEffect is it a lot of work to add this to API docs? can I help with PR?

EisenbergEffect commented 6 years ago

Let me see if I can add it real quick.

EisenbergEffect commented 6 years ago

Ok, it's added and published. However, there is a ton of basic description stuff missing, so it doesn't look great if you browse it.

Alexander-Taran commented 6 years ago

@EisenbergEffect thank you! @gheoan would you like to provide a PR to improve the docs for route-recognizer? or close this one?

gheoan commented 6 years ago

I have a branch for route-recognizer which adds more typescript types. Will send a PR when it's ready.