not-an-aardvark / snoowrap

A JavaScript wrapper for the reddit API
MIT License
1.01k stars 125 forks source link

Improve docs inter-links #364

Open Venefilyn opened 2 years ago

Venefilyn commented 2 years ago

Within https://github.com/not-an-aardvark/snoowrap/issues/43#issuecomment-927718824 there is a comment

For some things docs are still not the easiest to parse, it would be nice to have a link to the composeMessage method in the doc page of the PrivateMessage class. It may reduce confusion especially for newer users

Having interlinks within classes and functions will help eligibility and understanding of the codebase