Logmanager api documentation

aurelia / documentation

The documentation for Aurelia.

MIT License

105 stars 111 forks source link

Logmanager api documentation #365

Closed DickvdBrink closed 5 years ago

DickvdBrink commented 5 years ago

I'm submitting a bug report

Current behavior: https://aurelia.io/docs/api/framework/constant/LogManager is showing that LogManager is a

LogManager: "/Users/EisenbergEffect/Documents/GitHub/aurelia-current/framework/node_modules/aurelia-logging/dist/aurelia-logging"

So it is showing some local path which a user can't do anything with.

What is the expected behavior? The actual shape of the LogManager or a link to: https://aurelia.io/docs/api/logging

EisenbergEffect commented 5 years ago

Looks like a bug in TSDoc that generates this data. LogManager is a bit of an artificial export anyway. Instead, consider just importing directly from the Logger module. LogManager is basically just the module object for the Logger, so it has the same exports.

EisenbergEffect commented 5 years ago

We'll look into this to see if we can easily fix it.

EisenbergEffect commented 5 years ago

Fixed.

EisenbergEffect commented 5 years ago

(Or, rather we removed it because TSDoc isn't handling it properly. It's the best we can do for now.)