Skip to content

Commit 457e116

Browse files
committed
update readme due to api changes in save_to_memory which returns an io stream
1 parent 7f3b3b3 commit 457e116

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.rst

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ You need to pass a StringIO instance to Writer:
207207
... ]
208208
>>> io = StringIO()
209209
>>> sheet = pe.Sheet(data)
210-
>>> sheet.save_to_memory("ods", io)
210+
>>> io = sheet.save_to_memory("ods", io)
211211
>>> # then do something with io
212212
>>> # In reality, you might give it to your http response
213213
>>> # object for downloading
@@ -224,6 +224,7 @@ Development steps for code changes
224224

225225
#. git clone https://github.com/pyexcel/pyexcel-ods3.git
226226
#. cd pyexcel-ods3
227+
#. pip install -r rnd_requirements.txt # if such a file exists
227228
#. pip install -r requirements.txt
228229
#. pip install -r tests/requirements.txt
229230

@@ -235,6 +236,20 @@ required:
235236
#. git clone https://github.com/pyexcel/pyexcel-commons.git
236237
#. make your changes in `.moban.d` directory, then issue command `moban`
237238

239+
What is rnd_requirements.txt
240+
-------------------------------
241+
242+
Usually, it is created when a depdent library is not released. Once the dependecy is installed(will be released), the future version of the dependency in the requirements.txt will be valid.
243+
244+
What is pyexcel-commons
245+
---------------------------------
246+
247+
Many information that are shared across pyexcel projects, such as: this developer guide, license info, etc. are stored in `pyexcel-commons` project.
248+
249+
What is .moban.d
250+
---------------------------------
251+
252+
`.moban.d` stores the specific meta data for the library.
238253

239254
How to test your contribution
240255
------------------------------

0 commit comments

Comments
 (0)