Documentation of synonyms doesn't match code about duden HOT 3 CLOSED

Hi @Marrin , thank you for creating this issue! You are absolutely right: the documentation does not match the real output.

I fixed the usage document in #182 which now looks like this

I also thought about modifying the implementation to always return the single (first) item of the array, but I had some reservations (below), so I modified just the documentation for now. Reservations:

• breaking any code which expect DudenWord.synonyms an array
• the current implementation of .synonyms actually can return both a simple string as well as list of strings (or list of lists of strings, see recursively_extract function), based on the source HTML code.
  • the HTML always seems to contain a single <li> element under array <ul>, which is semantically a 1-item array, but I don't know if the website administrators plan to expand the array in the future. (Though I think they just forgot to remove the <ul><li> structure from there)
    

But if the content remains as a 1-item list, it might make practical sense to change the implementation and just return the first element.

What do you think?

from duden.

Hi @Marrin . I changed the code to return a list of synonyms, and modified documentation accordingly. If you find any word which does not print synonyms properly, please let me know.

from duden.

This change was released in 0.19.0 🎉

from duden.