Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(developer): Update context() and index() docs to remove caveat around context(n) offset #1888

Open
mcdurdin opened this issue Feb 21, 2025 · 0 comments · May be fixed by #1890
Open

docs(developer): Update context() and index() docs to remove caveat around context(n) offset #1888

mcdurdin opened this issue Feb 21, 2025 · 0 comments · May be fixed by #1890
Assignees
Labels
Milestone

Comments

@mcdurdin
Copy link
Member

mcdurdin commented Feb 21, 2025

Per analysis completed in keymanapp/keyman#13276, this caveat is unhelpful and only partially correct in any case. For v18, remove this caveat, and document history accordingly.

@mcdurdin mcdurdin changed the title Update the documentation for context() and index() (both currently make note of this special case) docs(developer): Update context() and index() docs to remove caveat around context(n) offset Feb 21, 2025
@mcdurdin mcdurdin moved this to Todo in Keyman Feb 21, 2025
@mcdurdin mcdurdin moved this from Todo to In Progress in Keyman Feb 21, 2025
@mcdurdin mcdurdin self-assigned this Feb 21, 2025
@mcdurdin mcdurdin added this to the B18S2 milestone Feb 21, 2025
@mcdurdin mcdurdin transferred this issue from keymanapp/keyman Feb 21, 2025
mcdurdin added a commit that referenced this issue Feb 21, 2025
Cleanup `context`, `index`, and `nul` documentation as well, tidy up
some examples.

Fixes: #1888
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

1 participant