Uploaded image for project: 'Ruby Driver'
  1. Ruby Driver
  2. RUBY-2227

Improve GridFS tutorial documentation

    • Type: Icon: Improvement Improvement
    • Resolution: Unresolved
    • Priority: Icon: Major - P3 Major - P3
    • None
    • Affects Version/s: None
    • Component/s: Docs
    • 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 Unassigned
            Reporter:
            oleg.pudeyev@mongodb.com Oleg Pudeyev (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: