You are here: CFCL Wiki>Projects/Elixir/HTD Web>ESL (18 Feb 2015, VickiBrown)

ESL

Hack The Docs is a collaborative editing project, focused on Elixir's online documentation. This page summarizes the activity and status of work on the Elixir Standard Library. The Master release has three sets of docs: Exceptions, Modules, and Protocols.

Interaction

The tables on this page support various kinds of interaction (eg, selecting, sorting, editing). Here are some introductory hints...

Selecting an Item

There are three tables, one for each documentation category: Exceptions, Modules, and Protocols. Each table contains a row for each entry (eg, Agent) in the category. Each table row has four columns:

  • Name (Agent, Application, ...)

  • Count - number of items (eg, functions, macros) in the entry

  • Status

    • Unknown - entry needs assessment
    • Mostly OK - only minor editing needed
    • To Do - Easy - entry looks easy to edit
    • To Do - Hard - entry looks hard to edit
    • In Progress - edits are in progress
    • Submitted - edits have been submitted
    • Accepted - edits have been accepted

  • Contact Information - name and/or IRC handle

Typically, if an entry has To Do - Hard status, the difficulty has to do with:

  • understanding and explaining

  • creating suitable examples

Sorting by Column

Click on a column heading to sort the entire table by that column. Click again to sort the other direction. Click a third time to disable sorting.

Editing Entries

Although the page as a whole is not editable, individual entries (ie, rows) are. Select a table to edit, then click the Edit button at the bottom.

Select a row to edit, then:

  • Edit the Contact Information field (one entry per line, please).
    Add your name, IRC handle, etc.

  • Change the row's Status value, as appropriate.

When you've made all of the desired edits, click the Save Table button. Or, if you think you've made a mistake, click the Cancel button. Do not leave an edit session in an unfinished state; that messes things up!

After you save, you'll be back on the page with the editable tables. You can edit another table or leave the page.

Exceptions

Status Table

Exception Name Count Status Contact Information
ArgumentError
2
Unknown
 
ArithmeticError
2
Unknown
 
BadArityError
2
Unknown
 
BadFunctionError
2
Unknown
 
BadStructError
2
Unknown
 
CaseClauseError
2
Unknown
 
Code.LoadError
2
Unknown
 
CompileError
2
Unknown
 
CondClauseError
2
Unknown
 
Enum.EmptyError
2
Unknown
 
Enum.OutOfBoundsError
2
Unknown
 
ErlangError
2
Unknown
 
File.CopyError
2
Unknown
 
File.Error
2
Unknown
 
FunctionClauseError
2
Unknown
 
IO.StreamError
2
Unknown
 
Inspect.Error
2
Unknown
 
KeyError
2
Unknown
 
MatchError
2
Unknown
 
Protocol.UndefinedError
2
Unknown
 
Regex.CompileError
2
Unknown
 
RuntimeError
2
Unknown
 
SyntaxError
2
Unknown
 
SystemLimitError
2
Unknown
 
TokenMissingError
2
Unknown
 
TryClauseError
2
Unknown
 
UndefinedFunctionError
2
Unknown
 
UnicodeConversionError
2
Unknown
 
Version.InvalidRequirementError
2
Unknown
 
Version.InvalidVersionError
2
Unknown
 

Known Problems



Modules

Status Table

Module Name Count Status Contact Information
Agent
13
To Do - Hard
 
Application
14
To Do - Hard
 
Atom
2
To Do - Easy
 
Base
15
Mostly OK
 
Behaviour
2
To Do - Hard
 
Bitwise
13
Submitted
RichMorin
Code
23
To Do - Hard
 
Dict
22
Mostly OK
 
Enum
66
Mostly OK
RichMorin
Exception
11
To Do - Hard
 
File
51
To Do - Hard
 
File.Stat
2
To Do - Hard
 
File.Stream
 
Mostly OK
 
Float
8
Mostly OK
 
GenEvent
14
To Do - Hard
 
GenEvent.Stream
 
Mostly OK
 
GenServer
7
To Do - Hard
 
HashDict
24
Mostly OK
 
HashSet
12
Mostly OK
 
IO
15
To Do - Hard
 
IO.ANSI
53
To Do - Hard
 
IO.Stream
 
To Do - Hard
 
Inspect.Algebra
16
To Do - Hard
 
Inspect.Opts
 
Mostly OK
 
Integer
9
To Do - Easy
 
Kernel
121
Mostly OK
 
Kernel.ParallelCompiler
2
Unknown
 
Kernel.ParallelRequire
1
Unknown
 
Kernel.SpecialForms
26
Mostly OK
 
Kernel.Typespec
16
To Do - Hard
 
Keyword
27
Mostly OK
 
List
27
Mostly OK
 
Macro
18
To Do - Hard
 
Macro.Env
4
To Do - Hard
 
Map
23
To Do - Easy
 
Module
20
To Do - Hard
 
Node
19
To Do - Hard
 
OptionParser
5
Mostly OK
 
Path
18
Mostly OK
 
Port
9
Mostly OK
 
Process
26
To Do - Hard
 
Protocol
8
To Do - Hard
 
Range
2
To Do - Easy
 
Record
5
Mostly OK
 
Regex
14
Mostly OK
 
Set
23
Mostly OK
 
Stream
31
Mostly OK
 
String
41
Mostly OK
 
StringIO
4
Mostly OK
 
Supervisor
8
To Do - Hard
 
Supervisor.Spec
3
To Do - Hard
 
System
21
To Do - Hard
 
Task
9
To Do - Hard
 
Task.Supervisor
7
To Do - Hard
 
Tuple
4
To Do - Easy
 
URI
13
To Do - Easy
 
Version
4
Mostly OK
 
Version.Requirement
?
Mostly OK
 

Known Problems

  • The sidebar for the Dict Module contains a duplicate list.



Protocols

Status Table

Protocol Name Count Status Contact Information
Access
2
Submitted
RichMorin
Collectable
1
Unknown
 
Enumerable
3
Unknown
 
Inspect
1
Unknown
 
List.Chars
1
Unknown
 
Range.Iterator
2
Unknown
 
String.Chars
1
Unknown
 

Known Problems


This wiki page is maintained by Rich Morin, an independent consultant specializing in software design, development, and documentation. Please feel free to email comments, inquiries, suggestions, etc!

Topic revision: r18 - 18 Feb 2015, VickiBrown
This site is powered by Foswiki Copyright © by the contributing authors. All material on this wiki is the property of the contributing authors.
Foswiki version v2.1.6, Release Foswiki-2.1.6, Plugin API version 2.4
Ideas, requests, problems regarding CFCL Wiki? Send us email

Edit  | Attach | Print version | History: r18 < r17 < r16 < r15 | Backlinks | View wiki text | More topic actions