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

modify instances of L<B<... |>...> to B<...>| #64

Merged
merged 1 commit into from
Dec 30, 2024

Conversation

finanalyst
Copy link
Contributor

@thoughtstream The changes in this PR are exclusively related to examples within code blocks with :allow<B>.

After much thought and discussion with @lizmat , and given it will take a considerable refactoring of the parser to allow for both:

A<B<this program |> SOFTWARE>

(of which there are two sets of examples)
and

X<array|B<arrays, definition of>>

I would suggest that we change the specification document (at least temporarily).

Both of the above are examples in the RakuDoc specification.

The first type is the problem. Essentially, the B<> markup has no problem gobbling the |. But then the outer A<> can no longer use the | character to separate the display part from the meta part.

Simply placing the | character outside the scope of the B<> markup resolves the problem completely. The final styling effect is minimal.

The work around in this PR is to copy the whole code block and place inside a comment block for a future revision, and then to modify the B<> markup.

@thoughtstream I am requesting a review since this appears to be the remaining outstanding issue we have.

Copy link

@thoughtstream thoughtstream left a comment

Choose a reason for hiding this comment

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

I'm fine with postponing this capability until the parser can be redesigned
(which, I acknowledge, may mean: indefinitely). It's a small issue and not
one that seems very likely to ever affect the vast majority of users.

@finanalyst finanalyst merged commit 16bff0e into main Dec 30, 2024
@finanalyst finanalyst deleted the stow_embedded_B_in_comments branch December 30, 2024 14:36
@jubilatious1
Copy link

What happens to a stray | pipe in a larger Raku script?

@finanalyst
Copy link
Contributor Author

@jubilatious1 a bit of extra info is needed in order to answer you. In the above examples, though, the code block's HTML goes awry. The error can cascade, or not, depending on the browser. Difficult to test for.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants