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

=config discussion from S26 is missing #4514

Open
tbrowder opened this issue Sep 18, 2024 · 2 comments
Open

=config discussion from S26 is missing #4514

tbrowder opened this issue Sep 18, 2024 · 2 comments
Labels
docs Documentation issue (primary issue type)

Comments

@tbrowder
Copy link
Member

Problem or new feature

For Pod6, add the missing text from S26 about adding separate config information for the whole document or as a one-liner.

Add examples.

NOTE: I am looking in the docs but can't find it--but it may be there.

If it's not, I'll file PR.

@tbrowder tbrowder added the docs Documentation issue (primary issue type) label Sep 18, 2024
@tbrowder tbrowder changed the title Ensure all user env vars are easily found, e.g., RAKUDO_POD_DECL_BLOCK_USER_FORMAT isn't easily found =config discussion is missing Sep 18, 2024
@tbrowder tbrowder changed the title =config discussion is missing =config discussion from S26 is missing Sep 18, 2024
@coke
Copy link
Collaborator

coke commented Sep 18, 2024

RAKUDO_POD_DECL_BLOCK_USER_FORMAT is not a language-spec'd env var, correct? It is listed here which I found with the google search.

https://docs.raku.org/language/pod

Note that S26 isn't "the spec" so if there's still items in there that are missing from the docs, it isn't necessarily a bug. Verify that something is referenced in roast

If it's rakudo specific (and therefore not spec), we need to include text to that effect when adding it (As was done for dd or this item on that page) -

This item could definitely get an index to make it easier to search for.

@finanalyst
Copy link
Collaborator

@tbrowder Please refer to Rendering of new RakuDoc v2. This has quite an extensive explanation of =config.
My new renderer handles (almost) all of RakuDoc v2. The current flaws are due to some peculiarities of Raku documentation, eg using X<> markup in =head blocks. The core renderer handles the markup well, but the HTML being generated is not escaping things properly.

RAKUDO_POD_DECL_BLOCK_USER_FORMAT is not mentioned at all in RakuDoc v2 because =config is expanded.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation issue (primary issue type)
Projects
None yet
Development

No branches or pull requests

3 participants