haddocking / pdb-tools

A dependency-free cross-platform swiss army knife for PDB files.
https://haddocking.github.io/pdb-tools/
Apache License 2.0
372 stars 113 forks source link

Adds for loop example to docs #95

Closed joaomcteixeira closed 3 years ago

joaomcteixeira commented 3 years ago

Every time I use pdb-tools I always feel it is an amazing tool. :heart_eyes: I believe extra examples can help the users understand the capabilities of the pdb-tools design.

This PR adds a little, yet powerful, example with bash for loop.

codecov[bot] commented 3 years ago

Codecov Report

Merging #95 (7a85271) into master (5c7039e) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #95   +/-   ##
=======================================
  Coverage   82.00%   82.00%           
=======================================
  Files          46       46           
  Lines        3663     3663           
  Branches      763      763           
=======================================
  Hits         3004     3004           
  Misses        469      469           
  Partials      190      190           

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 5c7039e...7a85271. Read the comment docs.

JoaoRodrigues commented 3 years ago

Following this example, we could have a cookbook with "recipes" for combining the tools. That could help newcomers get started?

joaomcteixeira commented 3 years ago

I agree, @JoaoRodrigues Actually, the submitted example is a tentative to seed that. Shall all those examples go to the current section or should there be a specific section of combination examples? Wherever it should go, once we decide on that, we can simply continue PR examples as we use them in our daily work.

JoaoRodrigues commented 3 years ago

We can add a COOKBOOK.md or an EXAMPLES.md file that simply lists examples in list. We'd have to link it to the index.md file so that it shows up in the web page and include this one in a setup.cfg file so that it is shipped with the code.

joaomcteixeira commented 3 years ago

Cookbook added in #97