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.

Sign up for GitHub

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

Jump to bottom

Clean Up the Standard Library Docs #1641

Merged
merged 18 commits into from
Apr 1, 2021
Merged

Clean Up the Standard Library Docs #1641

merged 18 commits into from
Apr 1, 2021

Conversation

iamrecursion
Copy link
Contributor

Pull Request Description

This PR cleans up the standard library docs, adding argument descriptions, tags, and type signatures where necessary. It also unifies the style for documentation across the standard library.

Closes #1460.
Closes #1447.

Important Notes

N/A

Checklist

Please include the following checklist in your PR:

  • The documentation has been updated if necessary.
  • All code conforms to the Scala, Java, and Rust style guides.
  • All documentation and configuration conforms to the markdown and YAML style guides.
  • All code has been tested where possible.

@iamrecursion iamrecursion added Type: Enhancement --breaking Important: a change that will break a public API or user-facing behaviour p-highest Should be completed ASAP labels Mar 31, 2021
@iamrecursion iamrecursion self-assigned this Mar 31, 2021
radeusgd
radeusgd reviewed Mar 31, 2021
View reviewed changes
Copy link
Member

@radeusgd radeusgd left a comment

Choose a reason for hiding this comment

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

I only managed to do a partial review due to time constraints.
I post what I found and if time allows I could follow up with more.

distribution/std-lib/Standard/src/Base/Data/Any/Extensions.enso Outdated Show resolved Hide resolved
distribution/std-lib/Standard/src/Base/Data/Any/Extensions.enso Outdated Show resolved Hide resolved
distribution/std-lib/Standard/src/Base/Data/Any/Extensions.enso Outdated Show resolved Hide resolved
distribution/std-lib/Standard/src/Base/Data/Any/Extensions.enso Outdated Show resolved Hide resolved
distribution/std-lib/Standard/src/Base/Data/Any/Extensions.enso Show resolved Hide resolved
distribution/std-lib/Standard/src/Base/Data/Array/Extensions.enso Show resolved Hide resolved
distribution/std-lib/Standard/src/Base/Data/Json.enso Outdated Show resolved Hide resolved
distribution/std-lib/Standard/src/Base/Data/Json.enso Outdated Show resolved Hide resolved
@radeusgd radeusgd mentioned this pull request Mar 31, 2021
Merged
4 tasks
4e6
4e6 approved these changes Apr 1, 2021
View reviewed changes
Copy link
Contributor

@4e6 4e6 left a comment

Choose a reason for hiding this comment

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

Tremendous job 👍

distribution/std-lib/Standard/src/Base/Data/Any/Extensions.enso Show resolved Hide resolved
distribution/std-lib/Standard/src/Base/Data/Any/Extensions.enso Outdated Show resolved Hide resolved
distribution/std-lib/Standard/src/Base/Data/Any/Extensions.enso Outdated Show resolved Hide resolved
@iamrecursion iamrecursion merged commit 9585080 into main Apr 1, 2021
@iamrecursion iamrecursion deleted the wip/ara/standard-docs branch April 1, 2021 11:20
iamrecursion added a commit that referenced this pull request Apr 7, 2021
@iamrecursion
Clean up the standard library docs (#1641)
5d4abcd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@radeusgd radeusgd radeusgd left review comments

@4e6 4e6 4e6 approved these changes

@kustosz kustosz Awaiting requested review from kustosz

@wdanilo wdanilo Awaiting requested review from wdanilo

Assignees

@iamrecursion iamrecursion

Labels
--breaking Important: a change that will break a public API or user-facing behaviour p-highest Should be completed ASAP
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Some Documentation is Outdated After Changing Error Handling to Dataflow Tag the Standard Library Properly
4 participants
@iamrecursion @4e6 @radeusgd @BinarySoftware