pimutils / pimutils/khal

search may not return expected results for events with long lines

Open
#1,058 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: bug
Dominant language
Python
Stars
3.1k
Forks
233
Avg merge
1h 44m
Merged PRs (30d)
1

Description

I have this event with a silly long summary:

2021-01-01-2021-01-01 File annual report (by January 30) at https://www.sec.state.ma.us/cor/. $500 business check to Commonwealth of Massachusetts ⟳

khal search r/ works as expected. khal search s/ doesn't return any results which is a bug. This because the .ics added a line break as an implementation detail:

SUMMARY:File annual report (by January 30) at <https://www.sec.state.ma.us
 /cor/>. $500 business check to Commonwealth of Massachusetts

The fix is probably to index fields without line breaks.

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 at the khal search entry point and reproduce the supplied event with both khal search r/ and khal search s/. Inspect how the .ics SUMMARY continuation line is indexed; done means searches return the event even when its summary contains an implementation line break.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, search
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.