Giter VIP home page Giter VIP logo

Comments (7)

dmitris avatar dmitris commented on May 26, 2024

There are more bad links in other Cookbook documents, need to be double-checked and fixed:

https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_CI.rst
https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_extending.rst
https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_in-depth.rst
https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst

There are also non-functional relative links:
For example, in the "Getting started" document, the "Mac" links points to
https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.rst#mac
but the section's anchor is https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.rst#mac-installation

Same with "Unit, Functional and Integration" links on https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst

from arrow.

klamping avatar klamping commented on May 26, 2024

Pull request added for the first five links. #32

I'll send more requests as I update the rest of the links.

from arrow.

dmitris avatar dmitris commented on May 26, 2024

On https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst, the relative links need to be fixed - instead of https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst#unit, https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst#functional and https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst#integration the links should point to:
https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst#unit-tests
https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst#functional-tests
https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst#integration-tests

There are also broken images in the middle of the page under "Functional tests" and "TODO... needs to be updated" comments.

from arrow.

dmitris avatar dmitris commented on May 26, 2024

Similarly, on https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.rst, all the "Verification" relative links are wrong - they point to a no-op https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.rst#verification instead of https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.rst#verifying-the-installation

from arrow.

dmitris avatar dmitris commented on May 26, 2024

Submitted #41 - but there's something strange about the way GitHub treats the internal link markup which differs from rst2html.py.

from arrow.

proverma avatar proverma commented on May 26, 2024

can we close this bug now ?

from arrow.

dmitris avatar dmitris commented on May 26, 2024

FAQ seems OK but there is a bad link in https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_CI.rst - "dimensions file" points to 404 https://github.com/yahoo/arrow/blob/master/arrow_in-depth.rst#test-descriptor-parametrization-and-test-environments

There are also bad/non-functional relative links on https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst ("Unit, Functional, and Integration")

On https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_in-depth.rst, if you search for "Descriptors", the relative link to https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_in-depth.rst#descriptors does not do anything (should be https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_in-depth.rst#test-descriptors)

On the same page, https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_in-depth.rst, the "martini_" shows as non-functional relative link in the sentence:
directory name starts with a prefix like "martini_";
(there is a commit comment "remove all the martini words" - should this one be gone as well?)

On https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.rst, "Verification" relative link in the phrase "Now you may proceed to Install Verification" is bad/non-functional - it points to https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.rst#verification but should be https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.rst#verifying-the-installation

from arrow.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.