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

Add comments in string_pool.cr #2228

Merged
merged 1 commit into from
May 30, 2016
Merged

Add comments in string_pool.cr #2228

merged 1 commit into from
May 30, 2016

Conversation

HeleneMyr
Copy link
Contributor

In file src/string_pool.cr :

  • Add documentation for the class string_pool
  • Add documentation for each methods

#
#
# require "string_pool"
# stringpool = StringPool.new
Copy link
Member

Choose a reason for hiding this comment

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

Maybe use string_pool or just pool for the variable name. Without _ it feels strange.

@HeleneMyr
Copy link
Contributor Author

I changed the description of StringPool, is it better ? @asterite

getter size

# Initialization of the elements
# At the begining, the size is null and the bucket is an array of size 11
Copy link
Member

Choose a reason for hiding this comment

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

The size is not "null". There are no "elements". Maybe just say "Creates a new empty StringPool".

Verified

This commit was signed with the committer’s verified signature.
jhass Jonne Haß
@jhass jhass merged commit 784ff37 into crystal-lang:master May 30, 2016
jhass added a commit that referenced this pull request May 30, 2016
Add comments in string_pool.cr
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