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): clarify context() offset with nul and if() #1890

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mcdurdin
Copy link
Member

@mcdurdin mcdurdin commented Feb 21, 2025

Breaking documentation change: removes the distinction that was listed for context(n) offset calculations; see keymanapp/keyman#13299 for details.

Cleanup context, index, and nul documentation as well, tidy up some examples.

Fixes: #1888

Cleanup `context`, `index`, and `nul` documentation as well, tidy up
some examples.

Fixes: #1888
@mcdurdin mcdurdin added this to the B18S2 milestone Feb 21, 2025
@mcdurdin mcdurdin added the docs label Feb 21, 2025
@mcdurdin mcdurdin marked this pull request as ready for review February 24, 2025 10:58
@@ -4,55 +4,56 @@ title: index()

## Summary

The **`index()`** statement maps a character from an input store to an
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see we're removing the bold formatting used to reference the current page's keyword?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have slowly been removing the bold; it seems unnecessary to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

docs(developer): Update context() and index() docs to remove caveat around context(n) offset
2 participants