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 ._no_rewrite = true to turn off rewriting (temporarily) on an element or function #129

Closed
Jaifroid opened this issue Dec 29, 2023 · 2 comments
Labels
wontfix This will not be worked on

Comments

@Jaifroid
Copy link

It appears that some elements or functions patched by Wombat have the possibility of turning off rewriting temporarily by setting a property ._no_rewrite = true. Is this a consistent property / API that developers can use? If so, it would be well worth documenting it if only in the README of this Repo.

Is there anywhere where such things are documented, other than trawling through the source code?

(Link to PR using this: kiwix/libkiwix#1036).

@ikreymer
Copy link
Member

ikreymer commented Jan 5, 2024

Yes, _no_rewrite is a property, that if set, will skip rewriting for particular elements. It is designed for internal use, since using it can break the rewriting system, so it was never intended for broader use. Most developers aren't using wombat in a custom way.

At this point, what is needed is a much broader documentation / cleanup pass on wombat, so I hesitate to single out this particular property (out of everything else here!), but happy to answer questions about it as they come up.

@ikreymer ikreymer closed this as completed Jan 5, 2024
@ikreymer ikreymer added the wontfix This will not be worked on label Jan 5, 2024
@Jaifroid
Copy link
Author

Jaifroid commented Jan 6, 2024

OK, the reason I asked was because knowing about this would have saved me hours of faffing around trying to find a way to get the underlying values, and #47 seems to be asking for something similar. But +1 for broader documentation. It would be hugely helpful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

2 participants