[go: up one dir, main page]
Menu ▾ ▴

#191 Update URLs

None
closed-fixed
nobody
None
5
2022-05-03
2022-01-20
Adam Turner
No

Documentation / minor change.

There are a lot of old URLs in the repo -- e.g. docutils.sf.net, docutils.sourceforge.net -- whilst these currently still work, we should update them all to the canonical https://docutils.sourceforge.io

This patch does that, and also generally updates several other links to https:// -- I tested each domain, so didn't update some old sourceforge domains that don't support https://. I also updated the docutils.dtd IDN in a single commit, so it can be dropped if wanted.

I'd certainly reccomend applying the first 4 commits, and ideally the entire patch.

https://github.com/AA-Turner/docutils/pull/10 // https://github.com/AA-Turner/docutils/pull/10.patch

A

Discussion

  • Günter Milde

    Günter Milde - 2022-01-20

    Thank you for the patch. Most of it is applied now.

    Changing the IDN breaks the validity of generated XML documents:

    #test/functional/expected >  xmllint standalone_rst_docutils_xml.xml --valid --noout
standalone_rst_docutils_xml.xml:4: validity error : Validation failed: no DTD found !

    Maybe this is also why flake8 failed?
    https://github.com/AA-Turner/docutils/runs/4877613719?check_suite_focus=true

    Commit 6/6 did not apply cleanly here and is also flagged "Some checks were not successful", so I leave it for now.

     

  • Adam Turner

    Adam Turner - 2022-01-20

    Changing the IDN breaks the validity of generated XML documents:

    I thought it was a bit of a riskier change!

    Commit 6/6 did not apply cleanly here

    Yeah, commit 6 won't apply if you don't apply #5 -- I kept them apart but should have thought about that, sorry. See https://github.com/AA-Turner/docutils/pull/11 // https://github.com/AA-Turner/docutils/pull/11.patch for the "clean" commit #6

    Maybe this is also why flake8 failed? // flagged "Some checks were not successful"

    Flake8 fails on master with the following errors -- it wasn't anything I introduced

    docutils/frontend.py:389:47: F821 undefined name 'locale_encoding'
docutils/utils/math/latex2mathml.py:861:1: C901 'handle_cmd' is too complex (68)
docutils/utils/math/latex2mathml.py:1210:52: E712 comparison to True should be 'if cond is True:' or 'if cond:'
docutils/utils/math/latex2mathml.py:1221:52: E712 comparison to True should be 'if cond is True:' or 'if cond:'
docutils/utils/math/math2html.py:2350:18: F821 undefined name 'Label'
docutils/utils/math/math2html.py:2353:5: F821 undefined name 'Label'

    A

     

    • Günter Milde

      Günter Milde - 2022-01-21

      On 2022-01-20, Adam Turner via Docutils-develop wrote in gmane.text.docutils.devel:

      Changing the IDN breaks the validity of generated XML documents:

      I thought it was a bit of a riskier change!

      Commit 6/6 did not apply cleanly here

      See > https://github.com/AA-Turner/docutils/pull/11.patch for the "clean"
      commit #6

      This is a massive change. I split it in documentation vs. code changes,
      fixed/updated some more URLs left out changes for "historic" docs, and
      dropped the change in MathML namespace specifiers to keep them valid.

      ...

      Flake8 fails on master with the following errors -- it wasn't anything I introduced

      Fixed. Thanks for telling.

      Thank you for your contributions.

       

      • Adam Turner

        Adam Turner - 2022-01-21

        Sorry if it caused a headache. It was really a search + replace http:// to https:// but I didn't want to do a commit per domain or etc. as it would have been many many small commits.

        Didn't realise the MathML point -- all tests passed, but if I changed the URL in the test then it is sort of a no-op.

        Thanks for fixing Flake8!

        A

         

  • Günter Milde

    Günter Milde - 2022-05-03
    • status: open --> closed-fixed
     

Log in to post a comment.