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

Standardize how to introduce implementation-dependent stuff #2213

Closed
tisonkun opened this issue Jul 24, 2018 · 7 comments
Closed

Standardize how to introduce implementation-dependent stuff #2213

tisonkun opened this issue Jul 24, 2018 · 7 comments
Labels
help wanted We need some help here wishlist "nice to have" issues; might require a lot of work or a big change or be low priority

Comments

@tisonkun
Copy link
Member

our documents are almost of Perl 6 spec.
on which implementation-dependent stuff, we could set a Rakudo NOTE paragraph for supplement.
i think it is time to standardize how these implementation-dependent stuff be introduced. in the current document, we might use parenthesis or just mix them into text. we need a elegant and scalable way to introduce those stuff, though.

ref #2212

@tisonkun tisonkun added wishlist "nice to have" issues; might require a lot of work or a big change or be low priority help wanted We need some help here labels Jul 24, 2018
@AlexDaniel
Copy link
Member

Related ticket: #1486

@zoffixznet
Copy link
Contributor

zoffixznet commented Jul 24, 2018

ref #2212

Just a minor note:

  • Some things are "globally" implementation-specific, such as .perl output, since the only requirement the language makes is for that output to be .EVALable to an equivalent object. These things might be OK to mix into general text.
  • Some things are implementation-specific to a specific implementation: for example, Rakudo implementation comes with Telemetry modules that aren't part of the language.

@tisonkun
Copy link
Member Author

close as not a problem

@JJ
Copy link
Contributor

JJ commented Aug 21, 2019

@tisonkun OK; your issue, your call, but it's not theoretically impossible to add metadata to paragraphs or index terms; with the new documentation specification, it's even relatively simple to do it. It's also a wishlist item, so it's pretty much guaranteed to be ignoredgiven a low priority. So it's not really a big deal if it stays.

@AlexDaniel AlexDaniel reopened this Aug 21, 2019
@tisonkun
Copy link
Member Author

I close issues because I myself am not interested in it any more. Anyone can open another issue and refer to this to continue the discussion.

...

@tisonkun
Copy link
Member Author

by "not a problem", I mean with the ongoing discussion we lost the context that "Perl 6 will have many implementation and thus Rakudo specific details are implementation-dependent", since we even want to "just name it Rakudo"

@tisonkun
Copy link
Member Author

tisonkun commented Sep 8, 2021

As rakudo/rakudo#1222 (comment), close this one. Please file another to continue the discussion if any.

@tisonkun tisonkun closed this as completed Sep 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted We need some help here wishlist "nice to have" issues; might require a lot of work or a big change or be low priority
Projects
None yet
Development

No branches or pull requests

4 participants