trompamusic / trompace-client

A python library to read from and write to the Trompa CE
Apache License 2.0
1 stars 0 forks source link

Add queries #35

Closed pc2752 closed 4 years ago

pc2752 commented 4 years ago

Added queries and tests for person and media object.

alastair commented 4 years ago

Please also add these items to the documentation. See the docs directory, look at docs/mutations.rst and docs/queries.rst. Run make html in this directory to build the docs.

pep8speaks commented 4 years ago

Hello @pc2752! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

Line 5:80: E501 line too long (83 > 79 characters) Line 13:80: E501 line too long (86 > 79 characters) Line 16:80: E501 line too long (83 > 79 characters) Line 17:80: E501 line too long (110 > 79 characters)

Line 24:80: E501 line too long (100 > 79 characters) Line 72:80: E501 line too long (96 > 79 characters) Line 74:80: E501 line too long (97 > 79 characters) Line 75:41: E128 continuation line under-indented for visual indent Line 76:41: E128 continuation line under-indented for visual indent Line 76:80: E501 line too long (96 > 79 characters) Line 77:41: E128 continuation line under-indented for visual indent Line 78:41: E128 continuation line under-indented for visual indent Line 78:80: E501 line too long (98 > 79 characters) Line 79:80: E501 line too long (102 > 79 characters) Line 83:80: E501 line too long (102 > 79 characters) Line 85:80: E501 line too long (97 > 79 characters) Line 86:41: E128 continuation line under-indented for visual indent Line 87:41: E128 continuation line under-indented for visual indent Line 87:80: E501 line too long (96 > 79 characters) Line 88:41: E128 continuation line under-indented for visual indent Line 89:41: E128 continuation line under-indented for visual indent Line 89:80: E501 line too long (98 > 79 characters) Line 90:80: E501 line too long (102 > 79 characters)

Line 5:80: E501 line too long (83 > 79 characters) Line 15:80: E501 line too long (81 > 79 characters) Line 19:80: E501 line too long (95 > 79 characters)

Line 2:80: E501 line too long (88 > 79 characters) Line 23:80: E501 line too long (118 > 79 characters) Line 24:80: E501 line too long (80 > 79 characters) Line 25:80: E501 line too long (84 > 79 characters) Line 65:80: E501 line too long (96 > 79 characters)

Line 2:80: E501 line too long (83 > 79 characters) Line 4:80: E501 line too long (88 > 79 characters) Line 8:80: E501 line too long (91 > 79 characters) Line 9:17: E128 continuation line under-indented for visual indent Line 9:80: E501 line too long (87 > 79 characters) Line 10:17: E128 continuation line under-indented for visual indent Line 15:80: E501 line too long (101 > 79 characters) Line 16:80: E501 line too long (90 > 79 characters) Line 17:80: E501 line too long (87 > 79 characters) Line 18:80: E501 line too long (87 > 79 characters) Line 25:80: E501 line too long (97 > 79 characters)

Line 5:80: E501 line too long (88 > 79 characters) Line 9:80: E501 line too long (86 > 79 characters) Line 10:17: E128 continuation line under-indented for visual indent Line 11:17: E128 continuation line under-indented for visual indent Line 11:80: E501 line too long (82 > 79 characters) Line 12:17: E128 continuation line under-indented for visual indent

Line 16:80: E501 line too long (80 > 79 characters) Line 29:80: E501 line too long (88 > 79 characters) Line 29:88: E502 the backslash is redundant between brackets Line 30:5: E128 continuation line under-indented for visual indent

Comment last updated at 2020-06-19 16:09:31 UTC
pc2752 commented 4 years ago

.

pc2752 commented 4 years ago

Please also add these items to the documentation. See the docs directory, look at docs/mutations.rst and docs/queries.rst. Run make html in this directory to build the docs.

I've added the entries to the rst files, not sure how the make command works. make html returns the following error:

Running Sphinx v1.3.6 making output directory... loading pickled environment... not yet created building [mo]: targets for 0 po files that are out of date building [html]: targets for 5 source files that are out of date updating environment: 5 added, 0 changed, 0 removed reading sources... [100%] queries

Sphinx error: master file /home/pc2752/share/repertoire/ce_queries/docs/contents.rst not found Makefile:20: recipe for target 'html' failed make: *** [html] Error 1

[EDIT] I was able to fix this by adding master_doc = 'index' in conf.py

alastair commented 4 years ago

Can you double-check the appearance of the documentation? To me it looks like this? Screenshot 2020-06-19 at 12 18 38 PM

compare the parameter and raises list here: https://trompace-client.readthedocs.io/en/latest/mutations.html#module-trompace.mutations.person

alastair commented 4 years ago

Please take a look at the comments from the pep8 bot. Don't worry about the line lengths, we'll update the configuration to set this to 120 characters.