stdlib icon indicating copy to clipboard operation
stdlib copied to clipboard

[RFC]: improve README examples of `stats/base/dists/logistic` namespace

Open Planeshifter opened this issue 1 year ago • 1 comments

Description

This RFC proposes to improve the README examples of the stats/base/dists/logistic namespace package. Currently, namespace package READMEs only include minimal examples which are not particularly informative and do not showcase namespace functionality.

Historically, namespace examples were not given much effort due to the rapidly changing nature of the project; however, now that development and organization has settled, it would be good to revisit these packages and add proper examples to better communicate to users how to use namespace contents.

For those wanting to contribute to this issue, you can use the following steps:

  • Browse through the contents of the stats/base/dists/logistic namespace and identify interesting functions and packages to showcase.
  • Update the example code block in the "Examples" section of the README for the stats/base/dists/logistic namespace and open a PR.
  • When updating the README, examples should follow existing project conventions (e.g., ES5).
  • Examples may require functionality from other packages to help make examples more interesting.

Related Issues

None.

Questions

No.

Other

No.

Checklist

  • [X] I have read and understood the Code of Conduct.
  • [X] Searched for existing issues and pull requests.
  • [X] The issue name begins with RFC:.

Planeshifter avatar Mar 03 '24 02:03 Planeshifter

Hi @Planeshifter I would like to work on this issue. It would be great if you could assign me to this issue. Thanks.

irusha avatar Mar 30 '24 11:03 irusha

I want to work on this issue. Please assign me for this task. @Planeshifter

Jash2606 avatar Jul 23 '24 06:07 Jash2606

@Planeshifter can you assign this issue to me?

AbhinavKRN avatar Jul 27 '24 17:07 AbhinavKRN

@Planeshifter I was working on this, is it closed or what?

AbhinavKRN avatar Jul 29 '24 12:07 AbhinavKRN

@AbhinavKRN This was closed, as, generally, we have received exceedingly low-quality PRs adding such examples. Individuals who have been submitting PRs for these issues have heavily relied on LLMs generating poor content, and the PRs have been a significant source of noise and headache for maintainers. As such, we closed all of them to help stop the deluge of low-quality PRs.

kgryte avatar Jul 29 '24 18:07 kgryte