# How to read Crystal documentation?

**URL:** <https://forum.crystal-lang.org/t/how-to-read-crystal-documentation/863>\
**Category:** Offtopic\
**Created:** [June 20, 2019, 5:48pm UTC](https://forum.crystal-lang.org/t/how-to-read-crystal-documentation/863 "2019-06-20T17:48:12Z")\
**Posts on this page:** 5\
**Page:** 2

<div class="post-metadata">

**Author:** ![Blacksmoke16](https://yyz2.discourse-cdn.com/flex036/user_avatar/forum.crystal-lang.org/blacksmoke16/32/1241_2.png) [@Blacksmoke16](https://forum.crystal-lang.org/u/Blacksmoke16)\
**Post date:** [June 23, 2019, 3:41am UTC](https://forum.crystal-lang.org/t/how-to-read-crystal-documentation/863/21 "2019-06-23T03:41:55Z")

</div>

You would have to fork it, otherwise it would try to create it in the actual repo, which you don’t have permission to do.

---

<div class="post-metadata">

**Author:** ![curious2learn](https://avatars.discourse-cdn.com/v4/letter/c/5daacb/32.png) [@curious2learn](https://forum.crystal-lang.org/u/curious2learn)\
**Post date:** [June 23, 2019, 4:09am UTC](https://forum.crystal-lang.org/t/how-to-read-crystal-documentation/863/22 "2019-06-23T04:09:11Z")

</div>

I have pushed the changes. The fork is at: [https://github.com/curioustolearn/crystal](https://github.com/curioustolearn/crystal)  
The branch which contains the changes is `sha256example`.

Thanks.

---

<div class="post-metadata">

**Author:** ![Blacksmoke16](https://yyz2.discourse-cdn.com/flex036/user_avatar/forum.crystal-lang.org/blacksmoke16/32/1241_2.png) [@Blacksmoke16](https://forum.crystal-lang.org/u/Blacksmoke16)\
**Post date:** [June 23, 2019, 4:51am UTC](https://forum.crystal-lang.org/t/how-to-read-crystal-documentation/863/23 "2019-06-23T04:51:24Z")

</div>

Running what @asterite suggested would fix it `crystal tool format`. The comment block has to be directly on top of the module definition. Those extra blank lines are causing it not to be seen.

But as I mentioned earlier, it would probably be better to add it to the actual method.

---

<div class="post-metadata">

**Author:** ![curious2learn](https://avatars.discourse-cdn.com/v4/letter/c/5daacb/32.png) [@curious2learn](https://forum.crystal-lang.org/u/curious2learn)\
**Post date:** [June 23, 2019, 1:34pm UTC](https://forum.crystal-lang.org/t/how-to-read-crystal-documentation/863/24 "2019-06-23T13:34:09Z")

</div>

Great! Fixing the extra space and running `crystal tool format` fixed it. As you suggested, I have moved the example to the `update` method in the `Digest` class. I pushed the branch again. Now I have to figure out how to create a pull request. Thank you.

---

<div class="post-metadata">

**Author:** ![curious2learn](https://avatars.discourse-cdn.com/v4/letter/c/5daacb/32.png) [@curious2learn](https://forum.crystal-lang.org/u/curious2learn)\
**Post date:** [June 23, 2019, 1:43pm UTC](https://forum.crystal-lang.org/t/how-to-read-crystal-documentation/863/25 "2019-06-23T13:43:53Z")

</div>

I have created the pull request on the original Crystal repo.

[Previous page](https://forum.crystal-lang.org/t/how-to-read-crystal-documentation/863.md?page=1)