| 821 | | |
| | 821 | == Task : Create User Examples for NumMatrix2D == |
| | 822 | |
| | 823 | '''Title''': Create User Examples for NumMatrix2D |
| | 824 | |
| | 825 | '''Category''': Code |
| | 826 | |
| | 827 | '''Difficulty''': medium |
| | 828 | |
| | 829 | '''Estimated time''': 4 hours |
| | 830 | |
| | 831 | '''Task description''': Consists of: |
| | 832 | |
| | 833 | * Code examples are an important part of any documentation for software users. Parrot-Linear-Algebra (PLA) has several pages of documentation for it's developers, but little documentation for it's users. Creating code examples is the first step in creating comprehensive user documentation for PLA. |
| | 834 | * Examples are needed for complex operations not covered by existing methods. |
| | 835 | * Some good code examples that would be: Calculate determinants of 2x2 and 3x3 matrices, create identity matrices, dot and cross products of two vectors, calculating the norm of a matrix, calculating the trace of a matrix, etc. |
| | 836 | * The student is expected to write at least 5 good code examples, with accompanying documentation/descriptions for use in user documentation. |
| | 837 | * Code examples can be written in any language which runs on Parrot (PIR, NQP, Winxed, Rakudo Perl 6, etc) |
| | 838 | |
| | 839 | '''Benefits''': PLA will benefit strongly from the addition of more user documentation, especially code examples. These code examples will be displayed on a public website for users to read, and will help new users to get started with PLA much more quickly. |
| | 840 | |
| | 841 | '''Requirements''': Knowledge of programming (no specific languages), Linear algebra, access to a Linux system |
| | 842 | |
| | 843 | '''Links''': http://github.com/Whiteknight/parrot-linear-algebra, http://whiteknight.github.com/parrot-linear-algebra |
| | 844 | |
| | 845 | '''Potential Mentor''': Whiteknight |
| | 846 | |
