Stream Wrappers really, really need documentation and examples [#872622]

OK, so we have Stream Wrappers in D7. What does that mean? Who knows?

There's an old but potentially helpful blog post.

There's #517814: File API Stream Wrapper Conversion where this was done.

But we really have to have these things:

An article explaining basic usage of stream wrappers.
An explanation of how D6 constructs map to D7 stream wrappers
An overhaul of the 6/7 module upgrade page that fixes all the reference to the old paradigm.
An entry in the 6/7 module upgrade page that explains this
An example module that shows how to use stream wrappers.

Comments

Comment #1

joachim commented 3 August 2010 at 13:52

A good way to proceed here might be to start a collaborative document (handbook page / wiki page on g.d.o), where the developers who created this system and therefore understand it can jot down brief notes, while documentation writers who are perhaps more skilled at presenting ideas can rewrite it into clear prose. A collaborative and iterative approach would be good, as it allows the writers to ask questions about things they don't understand, and the developers to correct anything that's misunderstood.

Comment #2

jhodgdon

she/her

English

commented 3 August 2010 at 14:48

Title:

Stream Wrappers really, really need documentation, examples, and upgrade information

» Stream Wrappers really, really need documentation and examples

Please discuss issues related to the upgrade guide on the original issue, and leave the discussion here to writing new documentation on how to use the new stream wrapper API. Which is desperately needed, I agree, and belongs within http://drupal.org/node/555118

And shouldn't the examples be a separate issue in the Examples for Developers project?