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

#1246 - Doc for keyword *bonds* of PDBWriter is wrong - attempt at fix #1279

Closed
wants to merge 4 commits into from
Closed

Conversation

Shtkddud123
Copy link
Contributor

Fixes #1246

Changes made in this Pull Request:

  • The init documentation for bonds has been fixed in a numpy style.
    PR Checklist

  • [ X] Tests?
  • Docs?
  • CHANGELOG updated?
  • Issue raised/referenced?

Copy link
Contributor

@jbarnoud jbarnoud left a comment

Choose a reason for hiding this comment

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

Thank you for your pull request. There are a few things to fix before it can be merged, though.

"""Create a new PDBWriter

Note
____
Copy link
Contributor

Choose a reason for hiding this comment

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

Should be dashes rather than underscores.

*multiframe*
the value of :data:`MDAnalysis.core.flags` ['convert_lengths']
bonds: :obj:, 'str', optional
If set to "conect", then write those bonds to the output file that were already defined in an input PDB file as PDB CONECT_ record. If set to "all", write all bonds (including guessed ones) to the file. ``None`` does not write any bonds. The default is "conect".
Copy link
Contributor

Choose a reason for hiding this comment

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

There is a large hole between "records." and "If".

``False``: write a single frame to the file; ``True``: create a
multi frame PDB file in which frames are written as MODEL_ ... ENDMDL_
records. If ``None``, then the class default is chosen. [``None``]

.. _CONECT: http://www.wwpdb.org/documentation/format32/sect10.html#CONECT
Copy link
Contributor

Choose a reason for hiding this comment

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

These lines link the occurrences of "_CONECT", "_MODEL", and "_ENDMDL" to the appropriate URL. They should not be removed.

@@ -1000,6 +998,23 @@ def CONECT(self, conect):
self.pdbfile.write(self.fmt['CONECT'].format(conect))


class PrimitivePDBReader(PDBReader):
Copy link
Contributor

Choose a reason for hiding this comment

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

This class and the next one were removed in a previous commit. They should not be reintroduced. Please rebase your branch against the develop branch so it is up to date.

@@ -206,7 +206,7 @@ def _check_lengths_match(*arrays):
if not all( a.shape == ref for a in arrays):
raise ValueError("Input arrays must all be same shape"
"Got {0}".format([a.shape for a in arrays]))

Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove the trailing spaces.

orbeckst pushed a commit that referenced this pull request May 1, 2017
- fixes #1246
- supercedes and closes PR #1279 by @Shtkddud123
- added @Shtkddud123 to AUTHORS
- updated CHANGELOG
orbeckst pushed a commit that referenced this pull request May 1, 2017
- fixes #1246
- supercedes and closes PR #1279 by @Shtkddud123
- added @Shtkddud123 to AUTHORS
- updated CHANGELOG
@orbeckst
Copy link
Member

orbeckst commented May 1, 2017

I fixed up the PR and resubmitted as PR #1329

@orbeckst orbeckst closed this May 1, 2017
kain88-de pushed a commit that referenced this pull request May 2, 2017
- fixes #1246
- supercedes and closes PR #1279 by @Shtkddud123
- added @Shtkddud123 to AUTHORS
- updated CHANGELOG
kain88-de pushed a commit that referenced this pull request May 2, 2017
- fixes #1246
- supercedes and closes PR #1279 by @Shtkddud123
- added @Shtkddud123 to AUTHORS
- updated CHANGELOG
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.

Doc for keyword *bonds* of PDBWriter is wrong
3 participants