Couchbase .NET client library

Method links anchor to awkward section of page

Details

  • Type: Bug Bug
  • Status: Resolved Resolved
  • Priority: Major 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.

Activity

Ascending order - Click to sort in descending order
John Zablocki made changes -
Field Original Value New Value
Fix Version/s 1.2.1 [ 10441 ]
Hide
Permalink
John Zablocki added a comment -
Karen - is there an easy way to change the anchoring?
Show
John Zablocki added a comment - Karen - is there an easy way to change the anchoring?
John Zablocki made changes -
Assignee John Zablocki [ john ] Karen Zeller [ kzeller ]
Hide
Permalink
Karen Zeller added a comment -
This has to do with our XML to HTML conversion and the jump-links that it creates. This needs to go to MC.
Show
Karen Zeller added a comment - This has to do with our XML to HTML conversion and the jump-links that it creates. This needs to go to MC.
Karen Zeller made changes -
Assignee Karen Zeller [ kzeller ] MC Brown [ mccouch ]
Hide
Permalink
MC Brown added a comment -
The links are automatically generated between the tables. The tables should be repositioned to be before any examples relating to their content, not afterwards.
Show
MC Brown added a comment - The links are automatically generated between the tables. The tables should be repositioned to be before any examples relating to their content, not afterwards.
Hide
Permalink
MC Brown added a comment -
I've reposition the tables within the .NET SDK doc
Show
MC Brown added a comment - I've reposition the tables within the .NET SDK doc
MC Brown made changes -
Status Open [ 1 ] Resolved [ 5 ]
Resolution Fixed [ 1 ]
Hide
Permalink
Perry Krug added a comment -
I'm still seeing these anchors drop into the page below where the text related to the method begins...am I missing something?
Show
Perry Krug added a comment - I'm still seeing these anchors drop into the page below where the text related to the method begins...am I missing something?
Perry Krug made changes -
Resolution Fixed [ 1 ]
Status Resolved [ 5 ] Reopened [ 4 ]
Hide
Permalink
MC Brown added a comment -
They link straight into the tables on that page, before the example, for me. Have you tried reloading?
Show
MC Brown added a comment - They link straight into the tables on that page, before the example, for me. Have you tried reloading?
Hide
Permalink
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 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?
Hide
Permalink
MC Brown 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
MC Brown 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
Permalink
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 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
Permalink
MC Brown added a comment -
OK, post sorting fixed, now rebuilding.
Show
MC Brown added a comment - OK, post sorting fixed, now rebuilding.
Hide
Permalink
MC Brown added a comment -
Fixed some additional areas where the text/tables are mismatched.
Show
MC Brown added a comment - Fixed some additional areas where the text/tables are mismatched.
MC Brown made changes -
Status Reopened [ 4 ] Resolved [ 5 ]
Resolution Fixed [ 1 ]

People

  • Assignee:
    MC Brown
    Reporter:
    Perry Krug
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: