Skip to content
Snippets Groups Projects
Commit 3d2e658b authored by Marco Biasini's avatar Marco Biasini
Browse files

documented how to report a problem

parent ebc0af97
No related branches found
No related tags found
No related merge requests found
Reporting a Problem
==============================================================================
When you run into a problem in OST or have question regarding it's usage, there
are a few things you can do to make the life of people helping you easier. If
you follow these simple steps, you will make sure, people understand what you are
after and will get a response more quickly.
* Provide a short explanation of what you tried to accomplish, the result you
were expecting and what you got instead. A good example would be: **I tried
to read the attached PDB file. The file looks clean to me, but OST fails with
the following error: "invalid coordinate on line 4."**
* If possible, attach a small script that reproduces the problem.
* Include the relevant error message in your report
* Include the version of OpenStructure you are using
* Specify your operating system
* If you compiled OpenStructure manually, also include the version for Qt,
Eigen, Python and Boost.
...@@ -7,6 +7,7 @@ OpenStructure documentation ...@@ -7,6 +7,7 @@ OpenStructure documentation
install install
intro intro
users
base/generic base/generic
base/base base/base
geom/geom geom/geom
...@@ -96,14 +97,10 @@ Varia ...@@ -96,14 +97,10 @@ Varia
**Supported File Formats:** :doc:`structure formats<io/structure_formats>` | :doc:`sequence formats <io/sequence_formats>` | :doc:`image formats <io/image_formats>` **Supported File Formats:** :doc:`structure formats<io/structure_formats>` | :doc:`sequence formats <io/sequence_formats>` | :doc:`image formats <io/image_formats>`
**Users** :doc:`Reporting a problem <users>`
Extending OpenStructure Extending OpenStructure
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
**Howto:** :doc:`write new modules <newmodule>` | :doc:`integrate third-party tools <external>` | :doc:`logging <base/logging>` | :doc:`instructions for developers <contributing>` **Howto:** :doc:`write new modules <newmodule>` | :doc:`integrate third-party tools <external>` | :doc:`logging <base/logging>` | :doc:`instructions for developers <contributing>`
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment