URLs to function docs? - Githubissues

geocompx / geocompy

Geocomputation with Python: an open source book and online resource for getting started in this space

https://py.geocompx.org/

Other

259 stars 47 forks source link

URLs to function docs? #232

Open michaeldorman opened 3 months ago

michaeldorman commented 3 months ago

Should we have links to function docs, in the text where it's first mentioned? Right now this is inconsistent

Robinlovelace commented 3 months ago

Pros and cons:

Pro: more useful
Con: time and possible maintenance burden if URLs change

Given that many people will read the book in non-sequential order I'm not sure there's much benefit of only linking on first mention. So tentatively suggest no, but no objections.

michaeldorman commented 3 months ago

I agree, so it's on the to-do list to remove the existing links to docs (which we have for some of the functions where they are first mentioned)