scrapinghub / scrapinghub/dateparser

Docs: clarify difference between "DEFAULT_LANGUAGES" and "languages" settings

Open
#1,218 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
2.9k
Forks
520
Avg merge
22h 56m
Merged PRs (30d)
6

Description

It would be helpful if the section on Default Languages in the docs made it clearer that DEFAULT_LANGUAGES is an additional setting and should not be confused with the main languages setting when parsing dates.

I don't entirely understand what it's meant to be used for anyway; more detailed explanation i.e. better documentation may help reduce the likelihood of them getting confused.

User (experience) story: I'm a new user to the library who perused the "Settings" section after skimming the introduction due to the particular problem I'm trying to solve. I ended up confusing the DEFAULT_LANGUAGES setting with languages – the two basically melded in my brain, likely helped by the fact they use identical formatting – and I consequently spent/wasted time debugging a problem (language-specific date formatting being outright ignored) that actually wasn't one.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Default Languages section in settings.html and compare it with the languages setting described in the linked introduction section. Clarify that DEFAULT_LANGUAGES is an additional setting, explain its intended use, and distinguish its effect from languages so a reader can tell which setting controls parsing.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.