Bug 1001913 - Bug: fix comments within code
Summary: Bug: fix comments within code
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: JBoss Data Grid 6
Classification: JBoss
Component: Documentation
Version: 6.2.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ER3
: 6.2.0
Assignee: Mandar Joshi
QA Contact: Misha H. Ali
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-08-28 06:22 UTC by Misha H. Ali
Modified: 2015-09-01 02:58 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Build: CSProcessor Builder Version 1.13 Build Name: 12532, Administration and Configuration Guide-6.2-Beta-3 Build Date: 28-08-2013 15:39:22 Topic ID: 13891-473744 [Latest]
Last Closed: 2013-11-07 22:49:53 UTC
Type: Bug

Attachments (Terms of Use)
Add an attachment (proposed patch, testcase, etc.)

Description Misha H. Ali 2013-08-28 06:22:34 UTC 
Title: Implementing a ConsistentHashFactory

Describe the issue:

The comments in pink should be outside the code sample and explaining each time one by one.
Comment 1 Misha H. Ali 2013-08-28 06:28:37 UTC 
Refer to other programmatic examples where the code is explained one line at a time for examples.
Comment 4 Misha H. Ali 2013-09-17 01:07:51 UTC 
Feedback:

1. Please provide a link to view to verify the content. 
2. Looks good, are the individual step details new or were they already there? If new, we should get SME and QE review for this.
Comment 6 Misha H. Ali 2013-09-23 01:35:56 UTC 
OK, then we should get the changes brewed for verification. I don't see a revision history for this bug ID.
Comment 8 Misha H. Ali 2013-10-01 00:34:15 UTC 
The complete code sample should be available at the top, as discussed in the standards meeting. So basically:

<full code>

<procedure>
Code breakdown into steps, with each step explaining a line.

Check older revisions of this topic for the complete code and add that before you explain the individual steps.
Comment 11 Misha H. Ali 2013-11-07 22:49:53 UTC 
This bug is approved and available at:

https://access.redhat.com/site/documentation/Red_Hat_JBoss_Data_Grid/
Note You need to log in before you can comment on or make changes to this bug.