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

Documentation outdated (v1.1.2 vs v1.2.7) #220

Open
sodiumnitrate opened this issue Sep 20, 2023 · 0 comments
Open

Documentation outdated (v1.1.2 vs v1.2.7) #220

sodiumnitrate opened this issue Sep 20, 2023 · 0 comments

Comments

@sodiumnitrate
Copy link

Hi,
As far as I can see, the only documentation for the C API is for v1.1.2. There seem to be key differences between these two versions, notably the two extra fields in the edlibAlignConfig struct.

Old documentation says to do something like:

EdlibAlignResult result = edlibAlign("ACGTTAC", 7, "CGTTAG", 6, edlibNewAlignConfig(-1, EDLIB_MODE_SHW, EDLIB_TASK_PATH));

while this gives an error in v1.2.7:

error: too few arguments to function ‘EdlibAlignConfig edlibNewAlignConfig(int, EdlibAlignMode, EdlibAlignTask, const EdlibEqualityPair*, int)’
    9 |                                     edlibNewAlignConfig(-1, EDLIB_MODE_SHW, EDLIB_TASK_PATH));
      |                                     ~~~~~~~~~~~~~~~~~~~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In file included from src/edlib_test.cpp:3:
src/edlib/include/edlib.h:146:32: note: declared here
  146 |     EDLIB_API EdlibAlignConfig edlibNewAlignConfig(
      |                                ^~~~~~~~~~~~~~~~~~~

The following works:

EdlibAlignResult result = edlibAlign("ACGTTAC", 7, "CGTTAG", 6, edlibNewAlignConfig(-1, EDLIB_MODE_SHW, EDLIB_TASK_PATH, NULL, 0));

While the code is commented quite well that I was able to figure it out quickly, I just wanted to note it here in case others are stuck. Of course, updating the docs would be ideal, but I understand it takes time.

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

No branches or pull requests

1 participant