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

Mistake in documentation of create_event_file #245

Closed
MariaHei opened this issue Nov 25, 2023 · 0 comments · Fixed by #247
Closed

Mistake in documentation of create_event_file #245

MariaHei opened this issue Nov 25, 2023 · 0 comments · Fixed by #247

Comments

@MariaHei
Copy link

What you were trying to do

I was trying to generate an event file using the pyndl.preprocess.create_event_file function like this

pyndl.preprocess.create_event_file("path/to/input/file.txt", 
    "path/to/output/file.tab.gz", 
    allowed_symbols="*", 
    context_structure="line", event_structure="line",
    cue_structure="word_to_word", verbose=true)

What actually happened

The event file was empty (except cues/toutcomes).

What the problem is

The documentation states here that allowed_symbols="*" is equivalent to allowed_symbols="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ". This seems to be incorrect. The function ran as expected as soon as I changed allowed_symbols to "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ".

System details

Happened both with pyndl from pip and pyndl from github.

derNarr added a commit that referenced this issue Nov 28, 2023
* fixes #245; adds allowed_symbols="all" and removes non working "*" version
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 a pull request may close this issue.

1 participant