Improve GridFS tutorial documentation

XMLWordPrintableJSON

    • Type: Improvement
    • Resolution: Gone away
    • Priority: Major - P3
    • None
    • Affects Version/s: None
    • Component/s: Docs
    • None
    • None
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?
    • None
    • None
    • None
    • None
    • None
    • None

      The tutorial documentation at https://docs.mongodb.com/ruby-driver/master/tutorials/ruby-driver-gridfs/ can be better organized and there are important points it does not cover. For example, it does not say how to provide metadata when using the stream interface and the metadata field which the docstrings state should be used is not mentioned at all.

      Related to https://jira.mongodb.org/browse/RUBY-2210, the documentation should mention which methods accept strings and which require IO objects.

            Assignee:
            Unassigned
            Reporter:
            Oleg Pudeyev (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: