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

document "augment, override, replace" keywords #573

Closed
bam80 opened this issue Dec 27, 2024 · 3 comments
Closed

document "augment, override, replace" keywords #573

bam80 opened this issue Dec 27, 2024 · 3 comments
Labels
documentation Indicates a need for improvements or additions to documentation help wanted Indicates that a maintainer wants help on an issue or pull request

Comments

@bam80
Copy link

bam80 commented Dec 27, 2024

XKB has a bunch of merging machinery for this, with 3 different merge keywords augment, override, replace.

Originally posted by @bluetech in #162 (review)

Could we please document these keywords?

Apparently, they could be present in different contexts.
I couldn't find any references to them in a wild.
Thanks.

@wismill
Copy link
Member

wismill commented Dec 27, 2024

At the beginning of the doc you linked there is a link to Ivan Pascal’s documentation. The best doc about the merge modes is this page.

The behavior of the merge modes is not totally clear though; see #209.

@wismill wismill added documentation Indicates a need for improvements or additions to documentation help wanted Indicates that a maintainer wants help on an issue or pull request labels Dec 27, 2024
@bam80
Copy link
Author

bam80 commented Dec 27, 2024

That helped, thanks.
But that's on the Web Archive (which even doesn't open here easily), so eventually we would have to take over on the documentation, I think.

@wismill
Copy link
Member

wismill commented Dec 27, 2024

@bam80 Again, from the beginning of the doc:

Due to the complexity of the format, this document is still in construction. Some additional resources are: […]

The doc is WIP but this project is seriously undermanned. Feel free to file a MR to improve the doc. Please do not open further issues about topics already marked as TODO in the doc.

@wismill wismill closed this as completed Dec 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Indicates a need for improvements or additions to documentation help wanted Indicates that a maintainer wants help on an issue or pull request
Projects
None yet
Development

No branches or pull requests

2 participants