<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 08:37:38 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>[GODRIVER-2010] Clean up documentation examples</title>
                <link>https://jira.mongodb.org/browse/GODRIVER-2010</link>
                <project id="14289" key="GODRIVER">Go Driver</project>
                    <description>&lt;p&gt;documentation_examples/examples.go is getting pretty large (~2700 LoC). Depending on how the Docs team references these examples, we could split the file into smaller files within the same directory. This might make these examples more accessible to users.&lt;/p&gt;

&lt;p&gt;Furthermore, we should make sure that all examples are actually being run through example_test.go. RunTransactionWithRetry(), CommitWithRetry(), and WithTransactionExample() are not actually tested.&lt;/p&gt;

&lt;p&gt;Finally add a README or at least document that these examples are pulled in automatically by the Docs team.&lt;/p&gt;

&lt;p&gt;Also, try to adhere to the new &lt;a href=&quot;https://docs.google.com/document/d/1FtUKxOaEmdFf4d3HcXAVIGed2awuwIWdkWc0YQIwPvk/edit&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;document&lt;/a&gt; on Go driver example code (e.g. use &lt;tt&gt;context.TODO()&lt;/tt&gt; everywhere.&lt;/p&gt;</description>
                <environment></environment>
        <key id="1715826">GODRIVER-2010</key>
            <summary>Clean up documentation examples</summary>
                <type id="3" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14718&amp;avatarType=issuetype">Task</type>
                                            <priority id="5" iconUrl="https://jira.mongodb.org/images/icons/priorities/trivial.svg">Trivial - P5</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="benji.rewis@mongodb.com">Benji Rewis</assignee>
                                    <reporter username="benji.rewis@mongodb.com">Benji Rewis</reporter>
                        <labels>
                    </labels>
                <created>Fri, 14 May 2021 13:23:39 +0000</created>
                <updated>Wed, 20 Apr 2022 19:40:09 +0000</updated>
                            <resolved>Wed, 20 Apr 2022 19:40:09 +0000</resolved>
                                                                    <component>Documentation</component>
                                        <votes>0</votes>
                                    <watches>2</watches>
                                                                                                                <comments>
                            <comment id="4495377" author="benji.rewis" created="Wed, 20 Apr 2022 19:40:09 +0000"  >&lt;p&gt;Added a README to &lt;tt&gt;examples/documentation_examples&lt;/tt&gt;&#160;explaining the purpose of&#160;&lt;tt&gt;examples.go&lt;/tt&gt;&#160;and&#160;&lt;tt&gt;examples_test.go&lt;/tt&gt;. Replaced &lt;tt&gt;context.Background()&lt;/tt&gt;&#160;with&#160;&lt;tt&gt;context.TODO()&lt;/tt&gt; in actual example code. Actually ran &lt;tt&gt;WithTransactionExample&lt;/tt&gt;. Used &lt;tt&gt;mtest.ClusterURI()&lt;/tt&gt; instead of hard-coding URIs. Reorganized &lt;tt&gt;examples_test.go&lt;/tt&gt;&#160;to use&#160;&lt;tt&gt;mtest&lt;/tt&gt; for server version/topology logic. Added links to examples pointing to where they appear/will appear on &lt;a href=&quot;http://www.mongodb.com/docs&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;www.mongodb.com/docs&lt;/a&gt;.&lt;/p&gt;</comment>
                            <comment id="4495374" author="xgen-internal-githook" created="Wed, 20 Apr 2022 19:39:24 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;Benjamin Rewis&apos;, &apos;email&apos;: &apos;32186188+benjirewis@users.noreply.github.com&apos;, &apos;username&apos;: &apos;benjirewis&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/GODRIVER-2010&quot; title=&quot;Clean up documentation examples&quot; class=&quot;issue-link&quot; data-issue-key=&quot;GODRIVER-2010&quot;&gt;&lt;del&gt;GODRIVER-2010&lt;/del&gt;&lt;/a&gt; Further clean up documentation examples. (#915)&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-go-driver/commit/db84b1d860ca75f9d17b0b273aca5c182b66fd2e&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-go-driver/commit/db84b1d860ca75f9d17b0b273aca5c182b66fd2e&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="4492401" author="benji.rewis" created="Tue, 19 Apr 2022 20:31:08 +0000"  >&lt;p&gt;&lt;a href=&quot;https://github.com/mongodb/mongo-go-driver/pull/915&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-go-driver/pull/915&lt;/a&gt;&lt;/p&gt;</comment>
                    </comments>
                    <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_10257" key="com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons">
                        <customfieldname>Documentation Changes</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="11861"><![CDATA[Not Needed]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|hr6k93:</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>