Skip to content

docs: cleanup documentation #1946

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

Merged
merged 36 commits into from
Dec 5, 2022
Merged

docs: cleanup documentation #1946

merged 36 commits into from
Dec 5, 2022

Conversation

agoose77
Copy link
Collaborator

@agoose77 agoose77 commented Dec 4, 2022

This PR

  • cleans up docstrings that were wonky, or missing fields. I didn't check them hugely for meaning; this was just a quick pass over the arguments lists.
  • addresses quirks in user-guide

I need to ping Martin to check some of the parquet/arrow parts.

Partially addresses #1916
Fixes #1893


📚 The documentation for this PR will be available at https://awkward-array.readthedocs.io/en/agoose77-docs-touch-ups/ once Read the Docs has finished building 🔨

@agoose77
Copy link
Collaborator Author

agoose77 commented Dec 4, 2022

This only touches docs, so it doesn't run any of the build tests. There doesn't seem to be a sane way to specify conditional required tests. We could make all workflows run for every PR, and skip every step if the job is not required, but that will bloat all of our workflows

@agoose77 agoose77 added the pr-next-release Required for the next release label Dec 4, 2022
@agoose77 agoose77 changed the title docs: remove _v2 use in 10-minutes-to... docs: touch-ups for v2 release Dec 4, 2022
@codecov
Copy link

codecov bot commented Dec 4, 2022

Codecov Report

Merging #1946 (dc0f91e) into main (65ffb92) will increase coverage by 0.01%.
The diff coverage is 72.72%.

Additional details and impacted files
Impacted Files Coverage Δ
src/awkward/highlevel.py 72.78% <ø> (ø)
src/awkward/operations/ak_argcartesian.py 78.94% <ø> (ø)
src/awkward/operations/ak_argcombinations.py 81.25% <ø> (ø)
src/awkward/operations/ak_argsort.py 100.00% <ø> (ø)
src/awkward/operations/ak_backend.py 100.00% <ø> (ø)
src/awkward/operations/ak_broadcast_arrays.py 100.00% <ø> (ø)
src/awkward/operations/ak_cartesian.py 89.76% <ø> (ø)
src/awkward/operations/ak_categories.py 100.00% <ø> (ø)
src/awkward/operations/ak_combinations.py 92.85% <ø> (ø)
src/awkward/operations/ak_concatenate.py 96.03% <ø> (ø)
... and 60 more

@agoose77 agoose77 force-pushed the agoose77/docs-touch-ups branch from cbd07d2 to d99d299 Compare December 4, 2022 23:43
@agoose77 agoose77 changed the title docs: touch-ups for v2 release docs: cleanup documentation Dec 5, 2022
@agoose77 agoose77 requested a review from jpivarski December 5, 2022 10:17
Copy link
Member

@jpivarski jpivarski left a comment

Choose a reason for hiding this comment

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

These are all improvements, with one exception, noted below. If it's hard to specify an exception to the auto-formatting (black?), it can stay.

@agoose77 agoose77 enabled auto-merge (squash) December 5, 2022 15:36
@agoose77 agoose77 disabled auto-merge December 5, 2022 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ak.to_parquet has lost its docstring documentation
2 participants