<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Wed Feb 07 22:02:57 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>[CXX-1530] Ensure example code is consistent with docs processes</title>
                <link>https://jira.mongodb.org/browse/CXX-1530</link>
                <project id="11980" key="CXX">C++ Driver</project>
                    <description>&lt;p&gt;(Mostly copy/pasted from &lt;a href=&quot;https://mongodbcr.appspot.com/189650001/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://mongodbcr.appspot.com/189650001/&lt;/a&gt;)&lt;/p&gt;

&lt;p&gt;Investigate which code in examples/ is actually used in documentation and ensure that unused examples are either used, merged with used examples, or deleted?&lt;/p&gt;

&lt;p&gt;Long ago the C++ driver team was asked to write examples as part of the &apos;rosetta stone&apos; of drivers examples. We didn&apos;t like that we were supposed to write those in a way that was disconnected to the repo (e.g.&#160;just as docs).&lt;/p&gt;

&lt;p&gt;So we put in annotations so we could have the docs team auto-extract them, and that way if we changed them in the code they would be updated.&lt;/p&gt;

&lt;p&gt;I don&apos;t know what happened with all of that, but we were annotating examples as follows:&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://github.com/mongodb/mongo-cxx-driver/blob/master/examples/mongocxx/query.cpp#L42&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-cxx-driver/blob/master/examples/mongocxx/query.cpp&amp;amp;#35;L42&lt;/a&gt; &lt;a href=&quot;https://github.com/mongodb/mongo-cxx-driver/blob/master/examples/mongocxx/query.cpp#L47&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-cxx-driver/blob/master/examples/mongocxx/query.cpp&amp;amp;#35;L47&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;Then it appears that at some point this work was lost, and then done again, under the mongodb.com/documentation&amp;#95;examples.cpp file:&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://github.com/mongodb/mongo-cxx-driver/blob/master/examples/mongocxx/mongodb.com/documentation_examples.cpp#L36&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-cxx-driver/blob/master/examples/mongocxx/mongodb.com/documentation&amp;amp;#95;examples.cpp&amp;amp;#35;L36&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;If the new files under mongodb.com are the right way to do it, then we should at least strip out the old annotations? I&apos;m also puzzled about why that prior art got lost in the shuffle.&lt;/p&gt;</description>
                <environment></environment>
        <key id="513406">CXX-1530</key>
            <summary>Ensure example code is consistent with docs processes</summary>
                <type id="4" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14710&amp;avatarType=issuetype">Improvement</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="13201">Fixed</resolution>
                                        <assignee username="roberto.sanchez@mongodb.com">Roberto Sanchez</assignee>
                                    <reporter username="ryan.timmons@mongodb.com">Ryan Timmons</reporter>
                        <labels>
                    </labels>
                <created>Mon, 19 Mar 2018 15:01:56 +0000</created>
                <updated>Sat, 28 Oct 2023 11:27:31 +0000</updated>
                            <resolved>Thu, 3 Sep 2020 13:46:50 +0000</resolved>
                                                    <fixVersion>3.7.0</fixVersion>
                    <fixVersion>3.7.0-beta1</fixVersion>
                                    <component>Documentation</component>
                                        <votes>0</votes>
                                    <watches>3</watches>
                                                                                                                <comments>
                            <comment id="3374178" author="xgen-internal-githook" created="Thu, 3 Sep 2020 13:46:24 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;Roberto C. S&#225;nchez&apos;, &apos;email&apos;: &apos;roberto@connexer.com&apos;, &apos;username&apos;: &apos;rcsanchez97&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/CXX-1530&quot; title=&quot;Ensure example code is consistent with docs processes&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CXX-1530&quot;&gt;&lt;del&gt;CXX-1530&lt;/del&gt;&lt;/a&gt; remove unused example comment annotations (#710)&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-cxx-driver/commit/4e9fcfd32b76c8d7c75482cdec4aa3681eb7a204&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-cxx-driver/commit/4e9fcfd32b76c8d7c75482cdec4aa3681eb7a204&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="1862080" author="jesse" created="Wed, 11 Apr 2018 23:43:08 +0000"  >&lt;p&gt;Let&apos;s include example code in rendered C++ Driver docs, too, not just the MongoDB Manual. At that time, reconsider how to check the server version for which examples to run, e.g. the change stream example requires a MongoDB 3.6+ replica set and soon a transaction example will require a 4.0+ replica set.&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10012">
                    <name>Related</name>
                                            <outwardlinks description="related to">
                                                        </outwardlinks>
                                                        </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|hr6mvz:</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>