Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documetation #314

Merged
merged 1 commit into from
Jul 6, 2018
Merged

Update documetation #314

merged 1 commit into from
Jul 6, 2018

Conversation

e1ee1e11
Copy link
Contributor

There are four changes :

  1. containers.rst:
    Add a newline to ensure syntax of admonition will take effect.
  2. image.rst:
    a) The default value of wait argument in create() is True. (refs image.py#L101)
    b) The first argument in create() is the binary data of the image. Therefore, image_data should be opened in 'rb' mode. Or you will get an error like:
>>> image_data = open('an_image.tar.gz').read()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/usr/lib/python3.4/codecs.py", line 319, in decode
    (result, consumed) = self._buffer_decode(data, self.errors, final)
UnicodeDecodeError: 'utf-8' codec can't decode byte 0xfd in position 0: invalid start byte
  1. operations.rst:
    Correct typo.

Signed-off-by: e1ee1e11 <e1ee1e11e1ee@gmail.com>
@codecov-io
Copy link

codecov-io commented Jun 29, 2018

Codecov Report

Merging #314 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #314   +/-   ##
=======================================
  Coverage   96.31%   96.31%           
=======================================
  Files          11       11           
  Lines         814      814           
  Branches      100      100           
=======================================
  Hits          784      784           
  Misses         10       10           
  Partials       20       20

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5811aa8...c541cc8. Read the comment docs.

Copy link
Contributor

@ajkavanagh ajkavanagh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks very much for the corrections. Much appreciated!

@ajkavanagh ajkavanagh merged commit 4c0141f into canonical:master Jul 6, 2018
lasizoillo pushed a commit to lasizoillo/pylxd that referenced this pull request Jul 13, 2018
1. containers.rst: Add a newline to ensure syntax of admonition will take effect.
2. image.rst:
  a) The default value of wait argument in create() is True. (refs image.py#L101)
  b) The first argument in create() is the binary data of the image. Therefore, image_data should be opened in 'rb' mode. Or you will get an error.
3. operations.rst: Correct typo.

Signed-off-by: e1ee1e11 <e1ee1e11e1ee@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants