<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Wed Feb 07 21:13:07 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary append 'field=key&field=summary' to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>MongoDB Jira</title>
    <link>https://jira.mongodb.org</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>9.7.1</version>
        <build-number>970001</build-number>
        <build-date>13-04-2023</build-date>
    </build-info>


<item>
            <title>[CDRIVER-1689] Document mongoc_handshake_data_append in the .h, not public doc </title>
                <link>https://jira.mongodb.org/browse/CDRIVER-1689</link>
                <project id="10030" key="CDRIVER">C Driver</project>
                    <description>&lt;p&gt;Despite the existence of a page on &lt;tt&gt;mongoc_handshake_data_append&lt;/tt&gt;, no other pages appear to link to it.&lt;/p&gt;</description>
                <environment></environment>
        <key id="322636">CDRIVER-1689</key>
            <summary>Document mongoc_handshake_data_append in the .h, not public doc </summary>
                <type id="1" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14703&amp;avatarType=issuetype">Bug</type>
                                            <priority id="3" iconUrl="https://jira.mongodb.org/images/icons/priorities/major.svg">Major - P3</priority>
                        <status id="6" iconUrl="https://jira.mongodb.org/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="success"/>
                                    <resolution id="9">Done</resolution>
                                        <assignee username="bjori">Hannes Magnusson</assignee>
                                    <reporter username="david.golden@mongodb.com">David Golden</reporter>
                        <labels>
                    </labels>
                <created>Tue, 11 Oct 2016 01:14:53 +0000</created>
                <updated>Wed, 19 Oct 2016 14:15:31 +0000</updated>
                            <resolved>Tue, 11 Oct 2016 23:07:44 +0000</resolved>
                                                    <fixVersion>1.5.0</fixVersion>
                                    <component>docs</component>
                                        <votes>0</votes>
                                    <watches>1</watches>
                                                                                                                <comments>
                            <comment id="1405896" author="xgen-internal-githook" created="Tue, 11 Oct 2016 22:54:07 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;username&apos;: u&apos;bjori&apos;, u&apos;name&apos;: u&apos;Hannes Magnusson&apos;, u&apos;email&apos;: u&apos;bjori@php.net&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-1689&quot; title=&quot;Document mongoc_handshake_data_append in the .h, not public doc &quot; class=&quot;issue-link&quot; data-issue-key=&quot;CDRIVER-1689&quot;&gt;&lt;del&gt;CDRIVER-1689&lt;/del&gt;&lt;/a&gt; Document mongoc_handshake_data_append in the .h, not public doc&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-c-driver/commit/2d085cf9ca8180a08cfcd8dd05909ab05bf0b430&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-c-driver/commit/2d085cf9ca8180a08cfcd8dd05909ab05bf0b430&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="1405249" author="david.golden" created="Tue, 11 Oct 2016 15:22:26 +0000"  >&lt;p&gt;Removing the doc page and adding docs to the header would be fine.&lt;/p&gt;</comment>
                            <comment id="1405211" author="bjori" created="Tue, 11 Oct 2016 15:09:50 +0000"  >&lt;p&gt;I don&apos;t mind removing the doc page. In our emails regarding this feature to the C++, PHP and HHVM driver developer we linked this page specifically, since it was only made for you guys. If you have no use for it, it makes no sense for us to keep it. I don&apos;t agree that this private internal function should be mentioned in the initialization section. Telling people about cool feature they are not supposed to use, will make them use it.&lt;/p&gt;


&lt;p&gt;There should be no other &quot;hidden&quot; pages. See &lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-1470&quot; title=&quot;Lingering manpages without a home&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CDRIVER-1470&quot;&gt;&lt;del&gt;CDRIVER-1470&lt;/del&gt;&lt;/a&gt; which fixed those that I found couple of months ago.&lt;/p&gt;


&lt;p&gt;Regarding searchability of our docs and improving our doc system, this was part of our OKRs for this quarter, but got reduce to not find a fully now system but improving the hosting situation so they get at least published.&lt;/p&gt;

&lt;p&gt;Our docs live on &lt;a href=&quot;http://mongoc.org/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;http://mongoc.org/&lt;/a&gt; and are updated on each release.&lt;br/&gt;
Bleeding edge, in development, docs are available on &lt;a href=&quot;https://s3.amazonaws.com/mciuploads/mongo-c-driver/docs/latest/index.html&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://s3.amazonaws.com/mciuploads/mongo-c-driver/docs/latest/index.html&lt;/a&gt; and are regenerated per commit.&lt;br/&gt;
Similarly, libbson docs are also available on &lt;a href=&quot;http://mongoc.org/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;http://mongoc.org/&lt;/a&gt; and per commit docs available on &lt;a href=&quot;https://s3.amazonaws.com/mciuploads/libbson/docs/latest/index.html&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://s3.amazonaws.com/mciuploads/libbson/docs/latest/index.html&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;If you have general suggestions regarding the docs, lets open another ticket for that, not a fan of mixing so many things into a ticket about mongoc_handshake_data_append().&lt;/p&gt;

&lt;p&gt;If I remove the doc page and add docblock in the header file, like you suggested, would that resolve this ticket?&lt;/p&gt;</comment>
                            <comment id="1404938" author="david.golden" created="Tue, 11 Oct 2016 10:24:13 +0000"  >&lt;p&gt;If you really don&apos;t want it part of the public docs, maybe remove the page and put its content in a comment in the header file that declares it. &lt;/p&gt;

&lt;p&gt;FWIW, as a developer of a driver based on mongoc, I find it annoying to have to hunt for documentation of a public API function, particularly since the docs site isn&apos;t easily searchable (until indexed by Google).  Are there any other public function that are undocumented or have hidden docs?&lt;/p&gt;

&lt;p&gt;Personally, I suggest at least mentioning it in the initialization section with a single sentence statement along the lines of &quot;for developers of drivers built on libmongoc only; see code comments for usage&quot;.  Otherwise, how is a third party driver dev supposed to know to use it?&lt;/p&gt;</comment>
                            <comment id="1404837" author="bjori" created="Tue, 11 Oct 2016 03:41:40 +0000"  >&lt;p&gt;It was intentional. If we had a jailbreaking api, it would be for this function. Its not a function that normal apps should use, only drivers based on mongoc. It is also not part of any toc, for the same reason.&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10012">
                    <name>Related</name>
                                                                <inwardlinks description="is related to">
                                        <issuelink>
            <issuekey id="308087">CDRIVER-1470</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="301581">CDRIVER-1391</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                    </issuelinks>
                <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_15850" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|hsqoy7:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10558" key="com.pyxis.greenhopper.jira:gh-global-rank">
                        <customfieldname>Rank (Obsolete)</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>9223372036854775807</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            </customfields>
    </item>
</channel>
</rss>