How about "known issues" document?

ruby / error_highlight

The gem enhances Exception#message by adding a short explanation where the exception is raised

MIT License

150 stars 23 forks source link

How about "known issues" document? #3

Closed pocke closed 1 year ago

pocke commented 3 years ago

This gem has known issues, so I think it is more helpful if a known issue document exists.

I know the following issues:

shift ^^^ with multibyte characters
comment and backslash ref: #2
IRB doesn't highlight

mame commented 3 years ago

Looks good. Where should we put such a document? Wiki, known_issues.md, or doc/ directory?

ttanimichi commented 3 years ago

The bottom of the README would be a good place

pocke commented 3 years ago

I think the README must have links to the known issues at least, but the details should be another place to keep the README short. I think GitHub Issue will be a good place, because we manage issues with GitHub Issue. It will avoid managing the same things in two places.

mame commented 3 years ago

I've created #4, #5 and #6