Skip to content

[doc] Documenting operators by name #23224

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

Open
Grinnz opened this issue Apr 24, 2025 · 1 comment
Open

[doc] Documenting operators by name #23224

Grinnz opened this issue Apr 24, 2025 · 1 comment

Comments

@Grinnz
Copy link
Contributor

Grinnz commented Apr 24, 2025

perlop is organized by type of operator, and not name of operator. This makes it difficult to search visually or programmatically for a specific operator by name (symbolic or alphabetic). Three options come to mind:

  1. Restructuring perlop by operator name. Quite disruptive and the current organization may have its own benefits.
  2. Adding a "by operator name" section to perlop, which then internally links to the existing section that documents each operator, similar to how https://perldoc.perl.org/perlfunc#Perl-Functions-by-Category works.
  3. Adding a new documentation page which has sections by operator name similar to perlfunc and perlvar, which then links to perlop as appropriate.

The existing perlop metadata or some other metadata may be useful to autogenerate such a layout.

@khwilliamson
Copy link
Contributor

I would be happy if we just mentioned the English names of operators at the principal place where they are explained.

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

No branches or pull requests

3 participants