Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TACHYON-935] Added the usage of links in the documentation in the tachyon.security packages #2193

Merged
merged 1 commit into from Dec 3, 2015

Conversation

HorizonNet
Copy link
Contributor

@AmplabJenkins
Copy link

Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Tachyon-Pull-Request-Builder/7107/
Test PASSed.

@@ -213,7 +213,7 @@ public void handle(Callback[] callbacks) throws IOException, UnsupportedCallback
/**
* An instance of this class represents a client user connecting to Tachyon service.
*
* It is maintained in a ThreadLocal variable based on the Thrift RPC mechanism.
* It is maintained in a {@link ThreadLocal} variable based on the Thrift RPC mechanism.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For standard library classes like ThreadLocal, would it make sense to only @link them the first time they are mentioned in a file? There's no benefit to being able to rename them with an IDE.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aaudiber The idea is a little bit different and does not have something to do with refactoring in the first place. I link them the first time they are mentioned in the documentation for a method. The reason is that if someone reads the docs and wants to jump right into that class without scrolling to the top of the file and search for the place where the class is mentioned the first time.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sgtm, thanks for explaining

@aaudiber
Copy link
Contributor

aaudiber commented Dec 2, 2015

Thanks for improving the docs and making them more resilient to renames! I left one comment

@aaudiber
Copy link
Contributor

aaudiber commented Dec 3, 2015

LGTM

aaudiber added a commit that referenced this pull request Dec 3, 2015
[TACHYON-935] Added the usage of links in the documentation in the tachyon.security packages
@aaudiber aaudiber merged commit 3e8069e into Alluxio:master Dec 3, 2015
@HorizonNet HorizonNet deleted the TACHYON-935 branch December 3, 2015 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants