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

Improve the math page #2353

Open
4 tasks
JJ opened this issue Oct 4, 2018 · 1 comment
Open
4 tasks

Improve the math page #2353

JJ opened this issue Oct 4, 2018 · 1 comment
Labels
docs Documentation issue (primary issue type) update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc. wishlist "nice to have" issues; might require a lot of work or a big change or be low priority

Comments

@JJ
Copy link
Contributor

JJ commented Oct 4, 2018

Introduction

You might need to have a quick introduction to the language. This is as short as it gets. If you have any question about Perl 6, it's probably better to either take it to StackOverflow or ask in the IRC channel, which you can access from the web.

The language used for the documentation is called Perl6 pod. You can pretty much follow the conventions that you already see in the document, but that guide above might help you find whatever is not there.

We are talking about this page, "Doing math with perl6", which you can edit directly on the GitHub page by clicking on the pencil right above the butterfly (a.k.a Camelia); saving it will generate a pull request, or via forking, editing locally and doing a pull request in the usual way.

The problem

Perl 6 includes extensive facilities for using math notation, and doing math with different types. The current page is short and includes only a few examples of sets, or arithmetic.

Suggestions

The page can be improved in many different ways, obviously not limited to the ones below.

  • Revise page for possible math terminology, or other, errors.
  • The Set section includes, effectively, only Sets, while Perl 6 includes several other kind of set-ty classes. Math on them could be added to that section
  • Most Set operations are not mentioned. Some examples of theorems proved using them, or simply solving some mathematical problems, would be interesting.
  • Perl 6 is a functional language. A section on type algebra would enhance this page.
@JJ JJ added docs Documentation issue (primary issue type) Hacktoberfest wishlist "nice to have" issues; might require a lot of work or a big change or be low priority update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc. labels Oct 4, 2018
JJ added a commit that referenced this issue Oct 7, 2018
Improve the math page with ODE's integrators #2353 
OK, some formatting problems, but I'll take care of that. Thanks a lot, it's a great contribution.
@ab5tract
Copy link
Contributor

Not directly math related, but I'm currently working on updating the documentation for sets, bags, and mixes page to be actually truthful to the current implementation.

So if you are adding anything set related, make sure you ignore most of what is currently written on that page, at least with regards to how the operators work with bags and mixes (and sets when they are involved in operations with bags and mixes).

luisbalru added a commit to luisbalru/doc that referenced this issue Oct 31, 2018
luisbalru added a commit to luisbalru/doc that referenced this issue Oct 31, 2018
luisbalru added a commit to luisbalru/doc that referenced this issue Oct 31, 2018
luisbalru added a commit to luisbalru/doc that referenced this issue Oct 31, 2018
JJ added a commit that referenced this issue Nov 1, 2018
@coke coke removed the Hacktoberfest label Mar 5, 2023
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) update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc. 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

3 participants