Skip to content

Commit d3bc401

Browse files
authored
Merge pull request #1654 from patzim/master
Some markup fixes for Language/Modules.
2 parents 836213d + 799e25c commit d3bc401

File tree

1 file changed

+24
-23
lines changed

1 file changed

+24
-23
lines changed

doc/Language/modules.pod6

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -507,7 +507,8 @@ lib
507507
tests (for now), you might have a look at how other modules use
508508
C<Test>. It's quite similar to Perl 5's C<Test::More>.
509509
510-
=item To document your modules, use L<Perl 6 Pod |
510+
=begin item
511+
To document your modules, use L<Perl 6 Pod |
511512
https://design.perl6.org/S26.html> markup inside your modules. Module
512513
documentation is most appreciated and will be especially important once
513514
the Perl 6 module directory (or some other site) begins rendering Pod docs
@@ -521,15 +522,16 @@ lib
521522
`-- TotalPerspective.pod6
522523
=end code
523524
524-
N«
525-
Note, described above is a minimal project directory. If your project
526-
contains scripts that you'd like distributed along with your module(s),
527-
put them in a C<bin> directory. If you'd like a graphical logo to
528-
appear next to your module at the module directory, create a
529-
C<logotype> directory and put into it a C<logo_32x32.png> file. At some
530-
point, you might also consider adding C<CONTRIBUTORS>, C<NEWS>,
531-
C<TODO>, or other files.
532-
»
525+
=end item
526+
527+
=item
528+
Note, described above is a minimal project directory. If your project
529+
contains scripts that you'd like distributed along with your module(s),
530+
put them in a C<bin> directory. If you'd like a graphical logo to
531+
appear next to your module at the module directory, create a
532+
C<logotype> directory and put into it a C<logo_32x32.png> file. At some
533+
point, you might also consider adding C<CONTRIBUTORS>, C<NEWS>,
534+
C<TODO>, or other files.
533535
534536
=begin item
535537
Make your X<C<META6.json>|META6.json> file look something like this:
@@ -589,8 +591,9 @@ lib
589591
To test your module you can use the following command to install the
590592
module directly from the module folder you just created.
591593
592-
=for code :lang<shell>
594+
=begin code :lang<shell>
593595
zef install ./your-module-folder
596+
=end code
594597
595598
=end item
596599
@@ -610,8 +613,9 @@ account. The process takes about 5 minutes and some e-mail back and forth.
610613
611614
If you use git you can also use the following command to create a package directly for a given commit.
612615
613-
=for code :lang<shell>
616+
=begin code :lang<shell>
614617
git archive --prefix=Vortex-TotalPerspective-0.0.1/ -o ../Vortex-TotalPerspective-0.0.1.tar.gz HEAD
618+
=end code
615619
616620
=end item
617621
@@ -623,20 +627,16 @@ account. The process takes about 5 minutes and some e-mail back and forth.
623627
=begin item
624628
Select your file and click I<Upload>!
625629
626-
N«
627-
Make sure you have a META6.json file in your dist and that the dist
628-
version you're uploading is higher than the currently uploaded version.
629-
Those are the most common upload errors.
630-
»
630+
I<Make sure you have a META6.json file in your dist and that the dist
631+
version you're uploading is higher than the currently uploaded version.
632+
Those are the most common upload errors.>
631633
632634
=end item
633635
634636
=head2 Upload your Module to p6c
635637
636-
N«
637-
The I<p6c> ecosystem is soon to be deprecated, so you should consider
638-
using the I<CPAN> ecosystem instead.
639-
»
638+
I<The p6c ecosystem is soon to be deprecated, so you should consider
639+
using the CPAN ecosystem instead.>
640640
641641
If you want to use the I<p6c> ecosystem you need to use git for your module's
642642
version control. The instructions herein assume that you have a
@@ -672,8 +672,9 @@ B<That's it! Thanks for contributing to the Perl 6 community!>
672672
If you'd like to try out installing your module, use the X<zef> module
673673
installer tool which is included with Rakudo Star Perl 6:
674674
675-
=for code :lang<shell>
676-
$ zef install Vortex::TotalPerspective
675+
=begin code :lang<shell>
676+
zef install Vortex::TotalPerspective
677+
=end code
677678
678679
This will download your module to its own working directory (C<~/.zef>),
679680
build it there, and install the module into your local Perl 6 installation directory.

0 commit comments

Comments
 (0)