Skip to content

Clarify unnecessary special handling for colons in paths. #15050

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
Merged
merged 1 commit into from
Aug 13, 2019
Merged

Clarify unnecessary special handling for colons in paths. #15050

merged 1 commit into from
Aug 13, 2019

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Aug 13, 2019

PR Summary

following ongoing discussion at #15048 (comment)

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@ImportanceOfBeingErnest
Copy link
Member

ImportanceOfBeingErnest commented Aug 13, 2019 •
edited
Loading

Not sure I understand this. #15048 fixed the error, now you want to introduce it again?

FYI, here is the

Complete Error Message 
# Sphinx version: 1.8.5
# Python version: 3.6.4 (CPython)
# Docutils version: 0.14 
# Jinja2 version: 2.10
# Last messages:
#   checking consistency...
#   
#   done
#   
#   preparing documents...
#   
#   done
#   
#   writing output... [  0%] api/_as_gen/matplotlib.animation.AVConvBase
#   
# Loaded extensions:
#   sphinx.ext.mathjax (1.8.5) from D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\ext\mathjax.py
#   alabaster (0.7.12) from D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\alabaster\__init__.py
#   sphinx.ext.autodoc (1.8.5) from D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\ext\autodoc\__init__.py
#   sphinx.ext.autosummary (1.8.5) from D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\ext\autosummary\__init__.py
#   sphinx.ext.doctest (1.8.5) from D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\ext\doctest.py
#   sphinx.ext.graphviz (1.8.5) from D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\ext\graphviz.py
#   sphinx.ext.inheritance_diagram (1.8.5) from D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\ext\inheritance_diagram.py
#   sphinx.ext.intersphinx (1.8.5) from D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\ext\intersphinx.py
#   sphinx.ext.ifconfig (1.8.5) from D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\ext\ifconfig.py
#   sphinx.ext.viewcode (1.8.5) from D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\ext\viewcode.py
#   IPython.sphinxext.ipython_console_highlighting (unknown version) from D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\IPython\sphinxext\ipython_console_highlighting.py
#   IPython.sphinxext.ipython_directive (unknown version) from D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\IPython\sphinxext\ipython_directive.py
#   numpydoc (0.8.0) from D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\numpydoc\__init__.py
#   sphinx_gallery.gen_gallery (0.5.0.dev0) from d:\data\computer\entwicklung\python\matplotlib\source\sphinx-gallery\sphinx_gallery\gen_gallery.py
#   matplotlib.sphinxext.mathmpl (unknown version) from d:\data\computer\entwicklung\python\matplotlib\source\matplotlibgit\matplotlib\lib\matplotlib\sphinxext\mathmpl.py
#   matplotlib.sphinxext.plot_directive (3.1.1.post1845+g80cfa20bd) from d:\data\computer\entwicklung\python\matplotlib\source\matplotlibgit\matplotlib\lib\matplotlib\sphinxext\plot_directive.py
#   sphinxext.custom_roles (unknown version) from D:\Data\Computer\Entwicklung\python\matplotlib\source\matplotlibgit\matplotlib\doc\sphinxext\custom_roles.py
#   sphinxext.github (unknown version) from D:\Data\Computer\Entwicklung\python\matplotlib\source\matplotlibgit\matplotlib\doc\sphinxext\github.py
#   sphinxext.math_symbol_table (unknown version) from D:\Data\Computer\Entwicklung\python\matplotlib\source\matplotlibgit\matplotlib\doc\sphinxext\math_symbol_table.py
#   sphinxext.missing_references (unknown version) from D:\Data\Computer\Entwicklung\python\matplotlib\source\matplotlibgit\matplotlib\doc\sphinxext\missing_references.py
#   sphinxext.mock_gui_toolkits (unknown version) from D:\Data\Computer\Entwicklung\python\matplotlib\source\matplotlibgit\matplotlib\doc\sphinxext\mock_gui_toolkits.py
#   sphinxext.skip_deprecated (unknown version) from D:\Data\Computer\Entwicklung\python\matplotlib\source\matplotlibgit\matplotlib\doc\sphinxext\skip_deprecated.py
#   sphinx_copybutton (0.2.5) from D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx_copybutton\__init__.py
Traceback (most recent call last):
  File "D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\cmd\build.py", line 304, in build_main
    app.build(args.force_all, filenames)
  File "D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\application.py", line 341, in build
    self.builder.build_update()
  File "D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\builders\__init__.py", line 347, in build_update
    len(to_build))
  File "D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\builders\__init__.py", line 412, in build
    self.write(docnames, list(updated_docnames), method)
  File "D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\builders\__init__.py", line 593, in write
    self._write_serial(sorted(docnames))
  File "D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\builders\__init__.py", line 601, in _write_serial
    doctree = self.env.get_and_resolve_doctree(docname, self)
  File "D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\environment\__init__.py", line 627, in get_and_resolve_doctree
    self.apply_post_transforms(doctree, docname)
  File "D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\environment\__init__.py", line 674, in apply_post_transforms
    transformer.apply_transforms()
  File "D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\transforms\__init__.py", line 90, in apply_transforms
    Transformer.apply_transforms(self)
  File "D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\docutils\transforms\__init__.py", line 171, in apply_transforms
    transform.apply(**kwargs)
  File "D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\transforms\post_transforms\__init__.py", line 97, in apply
    node, contnode)
  File "D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\application.py", line 520, in emit_firstresult
    return self.events.emit_firstresult(event, self, *args)
  File "D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\events.py", line 85, in emit_firstresult
    for result in self.emit(name, *args):
  File "D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\site-packages\sphinx\events.py", line 80, in emit
    results.append(callback(*args))
  File "D:\Data\Computer\Entwicklung\python\matplotlib\source\matplotlibgit\matplotlib\doc\sphinxext\missing_references.py", line 82, in record_missing_reference_handler
    record_missing_reference(app, env.missing_references_events, node)
  File "D:\Data\Computer\Entwicklung\python\matplotlib\source\matplotlibgit\matplotlib\doc\sphinxext\missing_references.py", line 62, in record_missing_reference
    location = get_location(node, app)
  File "D:\Data\Computer\Entwicklung\python\matplotlib\source\matplotlibgit\matplotlib\doc\sphinxext\missing_references.py", line 104, in get_location
    fullpath = Path(path).resolve()
  File "D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\pathlib.py", line 1119, in resolve
    s = self._flavour.resolve(self, strict=strict)
  File "D:\Programme\Entwicklung\Miniconda3\envs\mplgit\lib\pathlib.py", line 193, in resolve
    s = self._ext_to_normal(_getfinalpathname(s))
OSError: [WinError 123] Die Syntax für den Dateinamen, Verzeichnisnamen oder die Datenträgerbezeichnung ist falsch: 'd:\\data\\computer\\entwicklung\\python\\matplotlib\\source\\matplotlibgit\\matplotlib\\lib\\matplotlib\\animation.py:docstring of matplotlib.animation.AVConvBase.args_key:1:<autosummary>'

@anntzer anntzer changed the title Remove unnecessary special handling for colons in paths. Clarify unnecessary special handling for colons in paths. Aug 13, 2019
@anntzer
Copy link
Contributor Author

anntzer commented Aug 13, 2019

Ah, very sorry, I completely misunderstood the discussion. Rewrote the whole thing just to clarify my confusion which should have been solved by #15048 (comment).

@dstansby dstansby added this to the v3.2.0 milestone Aug 13, 2019
dstansby
dstansby approved these changes Aug 13, 2019
View reviewed changes
Copy link
Member

@dstansby dstansby left a comment

Choose a reason for hiding this comment

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

👍 when CI passes

@timhoffm timhoffm merged commit 453ff14 into matplotlib:master Aug 13, 2019
@anntzer anntzer deleted the colons branch August 13, 2019 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timhoffm timhoffm timhoffm approved these changes

@dstansby dstansby dstansby approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3.2.0
Development

Successfully merging this pull request may close these issues.
4 participants
@anntzer @ImportanceOfBeingErnest @timhoffm @dstansby