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.

Sign up for GitHub

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

Jump to bottom

Add Documentation section #7

Closed
doomspork opened this issue Jun 1, 2015 · 11 comments
Closed

Add Documentation section #7

doomspork opened this issue Jun 1, 2015 · 11 comments

Comments

@doomspork
Copy link
Member

Go over @moduledoc and @doc.
@doomspork
Copy link
Member Author

This should also include @doctest

@pjhampton
Copy link
Contributor

Hey doomspork.

Have you assigned anyone to this yet? If not, I would be keen to contribute.

pj

@doomspork
Copy link
Member Author

@pjhampton that would be stellar, thank you.

My initial plan was to cover @moduledoc, @doc, and @doctest but I'm open to suggestions. If you'd like to discuss, you can ping me on Slack as seanc.

@doomspork
Copy link
Member Author

Hi @pjhampton, still thinking of contributing this lesson?

@pjhampton
Copy link
Contributor

Hey @doomspork. Hell yeah! Sorry, I have just been a bit busy with work and the holidays. I will have a draft by sometime early next week. Don't mean to hold this up!

I will just gist an .md so we can discuss the content, instead of a commit.

@doomspork
Copy link
Member Author

That's great to hear @pjhampton. Don't mean to rush you, just checking in. 😀

@pjhampton
Copy link
Contributor

See this gist @doomspork

Still pretty raw, as I have only spent an hour on it so far. Still needs tidied up, proof read, etc. Some constructive feedback would be appreciated.

Thoughts

  • We will leave doc testing to the Testing section, I will add that separately.
  • We will add a best practice / * recap* section at the end.
  • Talk about deploying to hexdocs.pm.
  • Briefly Discuss using hexdoc without creating a mix project.

I tried to use Slack, but it seems like an exclusive club :-( Can't register. Sorry about that!!

@doomspork
Copy link
Member Author

Hey @pjhampton, I'll look this over today and leave you my thoughts. Thanks again for helping out. Always excited to have new contributors! 👍

@doomspork
Copy link
Member Author

@pjhampton it's looking good! Thanks again for taking the initiative on this.

You're not able to sign up @ http://bit.ly/slackelixir? I can jump on IRC if that's easier for you 😀

@pjhampton
Copy link
Contributor

Ahh, all signed up now 👍 I'm @pjhampton as usual.

We'll connect soon. Let me just clean this up as it's still a bit of a grammatical nightmare!

@pjhampton pjhampton mentioned this issue Jan 22, 2016
Merged
@doomspork
Copy link
Member Author

Closed by #74. Thanks again @pjhampton 👍

michalvalasek added a commit to exug-sk/elixir-school that referenced this issue Mar 10, 2016
@michalvalasek
Add Basics lesson elixirschool#7 (Funkcie).
a313c74
DenysonSoares pushed a commit to DenysonSoares/elixir-school that referenced this issue Mar 15, 2016
@michalvalasek @DenysonSoares
Add Basics lesson elixirschool#7 (Funkcie).
850128b
DenysonSoares pushed a commit to DenysonSoares/elixir-school that referenced this issue Mar 15, 2016
@DenysonSoares
Improve basics/mix.md PT translation
da6719b 
Add Plug to Portuguese(Brazil)

Translate specifics/ets.md page to Portuguese - issue elixirschool#123

Add Erlang interoperability to Portuguese (Brazil)

Related to issue elixirschool#122.

Add main index (in Slovak)

Add Basics lesson elixirschool#1 (Basics)

Add Basics lesson elixirschool#2 (Collections)

Fix List Substraction section in Basics/Collections

Add Basics lesson elixirschool#3 (Enum)

Add Basics lesson elixirschool#4 (Pattern matching)

Add Basics lesson elixirschool#5 (Control structures).

Add Basics lesson elixirschool#6 (Pipe operator).

Add Basics lesson elixirschool#7 (Funkcie).

Remove the local URL from main config.

Translate escripts.md to Portuguese
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@doomspork @pjhampton