Document and consistently use "Learn more" pattern when providing links in warnings or errors

XLSForm / pyxform

A Python package to create XForms for ODK Collect.

BSD 2-Clause "Simplified" License

77 stars 134 forks source link

Document and consistently use "Learn more" pattern when providing links in warnings or errors #634

Open lognaturel opened 1 year ago

lognaturel commented 1 year ago

We have a handful of links out to XLSForm docs: https://github.com/XLSForm/pyxform/blob/0839531ef2bcefb036c7c6ba1c19ce7ff82dc0c2/pyxform/xls2json.py#L526, https://github.com/XLSForm/pyxform/blob/0839531ef2bcefb036c7c6ba1c19ce7ff82dc0c2/pyxform/xls2json.py#L1246, https://github.com/XLSForm/pyxform/blob/d9413b503e4a6ab8423a6c1367726a90138e62aa/pyxform/survey.py#L1103

It would be good to introduce more and to make sure they have a consistent, documented format.

matthew-white commented 1 year ago

Just thought I'd mention a minor inconsistency, which is that the first link above has a period after the URL ("Learn more: [URL].") whereas the others don't ("Learn more: [URL]"). (Though I don't think it matters for Central at the moment, since we linkify URLs for warnings but not errors.)