Details

    • Type: Bug
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 1.2.0
    • Fix Version/s: 1.2.1
    • Component/s: docs
    • Labels:
      None

      Description

      This link: http://www.couchbase.com/docs/couchbase-sdk-net-1.2/couchbase-sdk-net-retrieve-get.html#table-couchbase-sdk_net_executeget

      Puts the anchor right on the API call, but cuts off the example above that introduces the ExecuteGet() method and the fact that it returns an IGetOperationResult. A customer would not know to scroll up a little bit.

      I have a sneaky suspicion that many of the other method links are anchored in awkward positions as well and it would be great to review and fix as many as possible so they make sense to a user navigating the documentation.

      No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

        Hide
        mccouch MC Brown (Inactive) added a comment -

        Fixed some additional areas where the text/tables are mismatched.

        Show
        mccouch MC Brown (Inactive) added a comment - Fixed some additional areas where the text/tables are mismatched.
        Hide
        mccouch MC Brown (Inactive) added a comment -

        OK, post sorting fixed, now rebuilding.

        Show
        mccouch MC Brown (Inactive) added a comment - OK, post sorting fixed, now rebuilding.
        Hide
        perry Perry Krug added a comment -

        Okay, well it seems that for multiple SDK docs, the first method is getting anchored to after it's introducing text...is that something we can fix?

        Show
        perry Perry Krug added a comment - Okay, well it seems that for multiple SDK docs, the first method is getting anchored to after it's introducing text...is that something we can fix?
        Hide
        mccouch MC Brown (Inactive) added a comment -

        Hmm, well, the table at the head of the chapter should be sorted alphabetically (and it's not), but the latter page should order the content in terms of how they are used (there is no point discussing the CAS without the simpler get() for example.

        The whole reason for the linking is that the order in the latter pages shouldn't matter because you don't have to scan for the right item - you are taken right to it.

        Show
        mccouch MC Brown (Inactive) added a comment - Hmm, well, the table at the head of the chapter should be sorted alphabetically (and it's not), but the latter page should order the content in terms of how they are used (there is no point discussing the CAS without the simpler get() for example. The whole reason for the linking is that the order in the latter pages shouldn't matter because you don't have to scan for the right item - you are taken right to it.
        Hide
        perry Perry Krug added a comment -

        Okay, now I see. I think the problem just "sort of" remains with the first anchor: http://www.couchbase.com/docs/couchbase-sdk-net-1.2/couchbase-sdk-net-retrieve-get.html#table-couchbase-sdk_net_get

        it drops you into the page, a few lines below where the page starts. I guess it's not too big a deal, but looked to me like the problem still existed.

        Is it considered at all confusing that the order of operations on the "Chapter 6" page doesn't match the order they are described on the 6.1 page?

        Show
        perry Perry Krug added a comment - Okay, now I see. I think the problem just "sort of" remains with the first anchor: http://www.couchbase.com/docs/couchbase-sdk-net-1.2/couchbase-sdk-net-retrieve-get.html#table-couchbase-sdk_net_get it drops you into the page, a few lines below where the page starts. I guess it's not too big a deal, but looked to me like the problem still existed. Is it considered at all confusing that the order of operations on the "Chapter 6" page doesn't match the order they are described on the 6.1 page?

          People

          • Assignee:
            mccouch MC Brown (Inactive)
            Reporter:
            perry Perry Krug
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Gerrit Reviews

              There are no open Gerrit changes