{"id":12980,"date":"2019-12-13T12:11:22","date_gmt":"2019-12-13T11:11:22","guid":{"rendered":"https:\/\/daniel.haxx.se\/blog\/?p=12980"},"modified":"2023-12-13T10:33:29","modified_gmt":"2023-12-13T09:33:29","slug":"reporting-documentation-bugs-in-curl-got-easier","status":"publish","type":"post","link":"https:\/\/daniel.haxx.se\/blog\/2019\/12\/13\/reporting-documentation-bugs-in-curl-got-easier\/","title":{"rendered":"Reporting documentation bugs in curl got easier"},"content":{"rendered":"\n<p>After I watched a talk by <a href=\"https:\/\/twitter.com\/marcusolsson\">Marcus Olsson<\/a> about <em>docs as code<\/em> (at foss-sthlm on December 12 2019), I got inspired to provide links on the curl web site to make it easier for users to report bugs on documentation.<\/p>\n\n\n\n<p>Starting today, there are two new links on the top right side of all libcurl API function call documentation pages.<\/p>\n\n\n\n<p><em>File a bug about this page<\/em> &#8211; takes the user directly to a new issue in the github issue tracker with the title filled in with the name of the function call, and the label preset to &#8216;documentation&#8217;. All there&#8217;s left is for the user to actually provide a description of the problem and pressing submit (and yeah, a github account is also required).<\/p>\n\n\n\n<p><em>View man page source<\/em> &#8211; instead takes the user over to browsing that particular man pages&#8217;s source file in the github source code repository.<\/p>\n\n\n\n<figure data-wp-context=\"{&quot;imageId&quot;:&quot;69e1c3f97ec62&quot;}\" data-wp-interactive=\"core\/image\" data-wp-key=\"69e1c3f97ec62\" class=\"wp-block-image size-large wp-lightbox-container\"><img loading=\"lazy\" decoding=\"async\" width=\"2369\" height=\"1323\" data-wp-class--hide=\"state.isContentHidden\" data-wp-class--show=\"state.isContentVisible\" data-wp-init=\"callbacks.setButtonStyles\" data-wp-on--click=\"actions.showLightbox\" data-wp-on--load=\"callbacks.setButtonStyles\" data-wp-on-window--resize=\"callbacks.setButtonStyles\" src=\"https:\/\/daniel.haxx.se\/blog\/wp-content\/uploads\/2019\/12\/manpage-report-bug.png\" alt=\"\" class=\"wp-image-13002\"\/><button\n\t\t\tclass=\"lightbox-trigger\"\n\t\t\ttype=\"button\"\n\t\t\taria-haspopup=\"dialog\"\n\t\t\taria-label=\"Enlarge\"\n\t\t\tdata-wp-init=\"callbacks.initTriggerButton\"\n\t\t\tdata-wp-on--click=\"actions.showLightbox\"\n\t\t\tdata-wp-style--right=\"state.imageButtonRight\"\n\t\t\tdata-wp-style--top=\"state.imageButtonTop\"\n\t\t>\n\t\t\t<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"12\" height=\"12\" fill=\"none\" viewBox=\"0 0 12 12\">\n\t\t\t\t<path fill=\"#fff\" d=\"M2 0a2 2 0 0 0-2 2v2h1.5V2a.5.5 0 0 1 .5-.5h2V0H2Zm2 10.5H2a.5.5 0 0 1-.5-.5V8H0v2a2 2 0 0 0 2 2h2v-1.5ZM8 12v-1.5h2a.5.5 0 0 0 .5-.5V8H12v2a2 2 0 0 1-2 2H8Zm2-12a2 2 0 0 1 2 2v2h-1.5V2a.5.5 0 0 0-.5-.5H8V0h2Z\" \/>\n\t\t\t<\/svg>\n\t\t<\/button><figcaption class=\"wp-element-caption\">Click the image for full resolution version.<\/figcaption><\/figure>\n\n\n\n<p>Since this is also already live on the site, you can also browse the documentation there. Like for example the <a href=\"https:\/\/curl.haxx.se\/libcurl\/c\/curl_easy_init.html\">curl_easy_init<\/a> man page.<\/p>\n\n\n\n<p>If you find mistakes or omissions in the docs &#8211; no matter how big or small &#8211; feel free to try out these links!<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Credits<\/h2>\n\n\n\n<p>Image by <a href=\"https:\/\/pixabay.com\/users\/Pexels-2286921\/?utm_source=link-attribution&amp;utm_medium=referral&amp;utm_campaign=image&amp;utm_content=1281581\">Pexels<\/a> from <a href=\"https:\/\/pixabay.com\/?utm_source=link-attribution&amp;utm_medium=referral&amp;utm_campaign=image&amp;utm_content=1281581\">Pixabay<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"<p>After I watched a talk by Marcus Olsson about docs as code (at foss-sthlm on December 12 2019), I got inspired to provide links on the curl web site to make it easier for users to report bugs on documentation. Starting today, there are two new links on the top right side of all libcurl &hellip; <a href=\"https:\/\/daniel.haxx.se\/blog\/2019\/12\/13\/reporting-documentation-bugs-in-curl-got-easier\/\" class=\"more-link\">Continue reading <span class=\"screen-reader-text\">Reporting documentation bugs in curl got easier<\/span> <span class=\"meta-nav\">&rarr;<\/span><\/a><\/p>\n","protected":false},"author":5,"featured_media":13004,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[7,6],"tags":[33,455],"class_list":["post-12980","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-curl","category-floss","tag-curl-and-libcurl","tag-documentation"],"_links":{"self":[{"href":"https:\/\/daniel.haxx.se\/blog\/wp-json\/wp\/v2\/posts\/12980","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/daniel.haxx.se\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/daniel.haxx.se\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/daniel.haxx.se\/blog\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/daniel.haxx.se\/blog\/wp-json\/wp\/v2\/comments?post=12980"}],"version-history":[{"count":9,"href":"https:\/\/daniel.haxx.se\/blog\/wp-json\/wp\/v2\/posts\/12980\/revisions"}],"predecessor-version":[{"id":23714,"href":"https:\/\/daniel.haxx.se\/blog\/wp-json\/wp\/v2\/posts\/12980\/revisions\/23714"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/daniel.haxx.se\/blog\/wp-json\/wp\/v2\/media\/13004"}],"wp:attachment":[{"href":"https:\/\/daniel.haxx.se\/blog\/wp-json\/wp\/v2\/media?parent=12980"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/daniel.haxx.se\/blog\/wp-json\/wp\/v2\/categories?post=12980"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/daniel.haxx.se\/blog\/wp-json\/wp\/v2\/tags?post=12980"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}