On Thursday, November 15, 2018 at 12:57:29 AM UTC-8, Andrew Milner wrote: > > Liz - what a good idea!! Would be good to have the links to the > documentation in all the weewx.conf sections, and also in the skin.conf > file, and maybe even a documentation.readme file detailing what documents > are actually available. > > Not a good idea.
Embedding pointers to docs is only good until the location the docs are in move due to any of a zillion possibilities including: - reorganizing the docs into a wiki or out or a wiki or whatever - rewriting them and moving around how-to-find-what into different docs Stuff happens. Learn how to google, and use the authoritative links on www.weewx.com rather than embedding non-authoritative pointers in config files. Remember, the contents of conf files are not messed with on version upgrades, so where it was when you started NNN releases ago might not be where that data is currently located. FWIW, I think putting anything other than a comment at the top of weewx.conf saying "# for documentation please see https://www.weewx.conf"; to me is not a good idea long-term. -- You received this message because you are subscribed to the Google Groups "weewx-user" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/d/optout.
