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

MAINT: Be nitpicky about docs #1437

Merged
merged 7 commits into from
Apr 27, 2023
Merged

MAINT: Be nitpicky about docs #1437

merged 7 commits into from
Apr 27, 2023

Conversation

larsoner
Copy link
Contributor

Closes #1436

  1. SPHINXOPTS wasn't used in doc/Makefile, now it is so you can do stuff like make clean && make html SPHINXOPTS="-nWT --keep-going -D sphinx_gallery_conf.filename_pattern=none"
  2. Modify SPHINXOPTS to use -nWT --keep-geing to be nitpicky
  3. Fix a bunch of nitpicky problems

There are a few left I still need to sort out but this is at least close to working locally.

@codecov
Copy link

codecov bot commented Apr 26, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: -0.65 ⚠️

Comparison is base (ebacd8c) 94.77% compared to head (49f3b9d) 94.12%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1437      +/-   ##
==========================================
- Coverage   94.77%   94.12%   -0.65%     
==========================================
  Files          44       44              
  Lines        7306     7307       +1     
==========================================
- Hits         6924     6878      -46     
- Misses        382      429      +47     
Impacted Files Coverage Δ
joblib/compressor.py 89.14% <ø> (ø)
joblib/hashing.py 91.22% <ø> (ø)
joblib/numpy_pickle.py 99.14% <ø> (ø)
joblib/numpy_pickle_compat.py 91.08% <ø> (ø)
joblib/parallel.py 97.07% <ø> (-0.17%) ⬇️
joblib/_cloudpickle_wrapper.py 100.00% <100.00%> (ø)
joblib/test/test_cloudpickle_wrapper.py 100.00% <100.00%> (ø)

... and 11 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Contributor

@tomMoral tomMoral left a comment

Choose a reason for hiding this comment

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

Nice, thanks for the fixes @larsoner !!

Do you recommend we have part of the CI that breaks when some nitpicks are not solved? (changing the readthedoc build command) This would avoid reintroducing errors?

@larsoner larsoner changed the title WIP: Be nitpicky about docs MAINT: Be nitpicky about docs Apr 26, 2023
@larsoner
Copy link
Contributor Author

Yes I would change the RTD build command. I can look into that or feel free to push a commit

This fixes the original problem for me:

$ python -m sphinx.ext.intersphinx _build/html/objects.inv | grep "joblib\.parallel_backend"
	joblib.parallel_backend                  parallel.html#joblib.parallel_backend

@larsoner
Copy link
Contributor Author

... actually IIRC the RTD stuff lives on the RTD site itself (?) so someone else might need to change it. I did at least make it that locally now it builds with -nWT --keep-going by default

@@ -118,7 +118,7 @@ def func_async(i, *args):
###############################################################################
# To have both fast pickling, safe process creation and serialization of
# interactive functions, ``loky`` provides a wrapper function
# :func:`wrap_non_picklable_objects` to wrap the non-picklable function and
# ``wrap_non_picklable_objects`` to wrap the non-picklable function and
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Locally for me at least this function had no docstring :(

@tomMoral
Copy link
Contributor

Ok it seems to be run with -W --keep-going now
image

Thanks a lot for fixing most of the errors @larsoner.
For the wrap_unpicklable_objects, I don't get why it does not pick up the docstring from loky... Let's say we investigate in another PR :)

@tomMoral tomMoral merged commit 8a1faea into joblib:master Apr 27, 2023
@tomMoral
Copy link
Contributor

Thx a lot @larsoner !

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.

DOC: joblib.parallel_backend no longer in intersphinx
2 participants