11ty / 11ty/docs

Pitfall: nunjucks-date vs nunjucks-date-filter

Open
#231 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Nunjucks
Stars
547
Forks
726
Avg merge
2h 23m
Merged PRs (30d)
3

Description

I read the documentation on the timezone errors with formatting dates, but nonetheless had trouble getting stuff to format correctly. I've only just now realized that nunjucks-date and nunjucks-date-filter are two separate packages (with identical interfaces it seems) and that only the latter formats things in UTC by default as is needed here. I don't know if this belongs in the documentation because it's about an external package, but I was confused by it for a few days.

Contributor guide

No contributing guide indexed for this repository

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 documentation section covering timezone errors when formatting dates and review how nunjucks-date and nunjucks-date-filter are described. Done means clearly distinguishing the two external packages and recording the relevant UTC-default behavior without implying they are the same package.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.