<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Wed Feb 07 22:01:44 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-1196] Improve mongocxx::instance documentation</title>
                <link>https://jira.mongodb.org/browse/CXX-1196</link>
                <project id="11980" key="CXX">C++ Driver</project>
                    <description>&lt;p&gt;mongocxx::instance is under-documented and difficult to use correctly.  We should make the following improvements to our documentation of mongocxx::instance:&lt;/p&gt;
&lt;ul class=&quot;alternate&quot; type=&quot;square&quot;&gt;
	&lt;li&gt;The mongocxx &quot;Quick Start&quot; page under &quot;Tutorial for mongocxx&quot; does not mention mongocxx::instance.  We should add a section which explains what mongocxx::instance is, and also makes a recommendation to users on how to manage this object.&lt;/li&gt;
	&lt;li&gt;All mongocxx examples should contain a code comment indicating that creating a mongocxx::instance object is necessary to initialize the driver.&lt;/li&gt;
	&lt;li&gt;The class comment for instance.hpp should be expanded.  In particular, it should:
	&lt;ul class=&quot;alternate&quot; type=&quot;square&quot;&gt;
		&lt;li&gt;Indicate explicitly that the mongocxx::instance constructor initializes the driver and that mongocxx::instance destructor shuts down the driver.&lt;/li&gt;
		&lt;li&gt;Explain that instantiating mongocxx::instance more than once in the same program is an error (even if the objects have non-overlapping lifetimes).&lt;/li&gt;
		&lt;li&gt;Contain a short example of basic correct usage of mongocxx::instance.&lt;/li&gt;
		&lt;li&gt;Contain an example of common incorrect usage of mongocxx::instance.&lt;/li&gt;
		&lt;li&gt;Refer users to the &quot;instance_management&quot; example for advanced mongocxx::instance usage.&lt;/li&gt;
	&lt;/ul&gt;
	&lt;/li&gt;
&lt;/ul&gt;
</description>
                <environment></environment>
        <key id="347240">CXX-1196</key>
            <summary>Improve mongocxx::instance documentation</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="sam.rossi@mongodb.com">Samuel Rossi</assignee>
                                    <reporter username="rassi">J Rassi</reporter>
                        <labels>
                    </labels>
                <created>Fri, 20 Jan 2017 01:12:18 +0000</created>
                <updated>Tue, 7 Mar 2017 18:04:31 +0000</updated>
                            <resolved>Tue, 7 Mar 2017 18:04:31 +0000</resolved>
                                                    <fixVersion>3.2.0-rc0</fixVersion>
                                    <component>Documentation</component>
                                        <votes>0</votes>
                                    <watches>2</watches>
                                                                                                                <comments>
                            <comment id="1518037" author="xgen-internal-githook" created="Tue, 7 Mar 2017 18:01:50 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;email&apos;: &apos;saghmrossi@gmail.com&apos;, &apos;username&apos;: &apos;saghm&apos;, &apos;name&apos;: &apos;Saghm Rossi&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/CXX-1196&quot; title=&quot;Improve mongocxx::instance documentation&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CXX-1196&quot;&gt;&lt;del&gt;CXX-1196&lt;/del&gt;&lt;/a&gt; Improve mongocxx::instance documentation&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-cxx-driver/commit/8b81c5e1c16651f75c756cac9e76837f0e293a60&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-cxx-driver/commit/8b81c5e1c16651f75c756cac9e76837f0e293a60&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="1518036" author="xgen-internal-githook" created="Tue, 7 Mar 2017 18:01:49 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;username&apos;: u&apos;saghm&apos;, u&apos;name&apos;: u&apos;Saghm Rossi&apos;, u&apos;email&apos;: u&apos;saghmrossi@gmail.com&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/CXX-1196&quot; title=&quot;Improve mongocxx::instance documentation&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CXX-1196&quot;&gt;&lt;del&gt;CXX-1196&lt;/del&gt;&lt;/a&gt; Improve mongocxx::instance documentation&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-cxx-driver/commit/8b81c5e1c16651f75c756cac9e76837f0e293a60&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-cxx-driver/commit/8b81c5e1c16651f75c756cac9e76837f0e293a60&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="1506557" author="rassi@10gen.com" created="Wed, 22 Feb 2017 22:04:52 +0000"  >&lt;p&gt;Per a discussion with Bernie from last week, I&apos;m going to re-open this ticket and expand its scope to cover the examples, and the instance class comment, too.  Thanks for addressing the tutorial, Sam.&lt;/p&gt;</comment>
                            <comment id="1506251" author="xgen-internal-githook" created="Wed, 22 Feb 2017 17:35:39 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;username&apos;: u&apos;saghm&apos;, u&apos;name&apos;: u&apos;Saghm Rossi&apos;, u&apos;email&apos;: u&apos;saghmrossi@gmail.com&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/CXX-1196&quot; title=&quot;Improve mongocxx::instance documentation&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CXX-1196&quot;&gt;&lt;del&gt;CXX-1196&lt;/del&gt;&lt;/a&gt;: &quot;Tutorial for mongocxx&quot; needs to explain mongocxx::instance&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-cxx-driver/commit/bb39a41bc262587772dc5a03552467dbf49b8878&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-cxx-driver/commit/bb39a41bc262587772dc5a03552467dbf49b8878&lt;/a&gt;&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10012">
                    <name>Related</name>
                                            <outwardlinks description="related to">
                                        <issuelink>
            <issuekey id="278432">CXX-890</issuekey>
        </issuelink>
                            </outwardlinks>
                                                                <inwardlinks description="is related to">
                                        <issuelink>
            <issuekey id="355195">CXX-1224</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="347247">CXX-1197</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="296701">CXX-958</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|hsvyyf:</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>
                                                                                                                                                                                                                                                                    <customfield id="customfield_10557" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue id="1601">Perl/CXX 2017-03-24</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            </customfields>
    </item>
</channel>
</rss>