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.

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

Harmonize public PMC names in pod #1079

Closed
rurban opened this issue Jun 15, 2014 · 2 comments
Closed

Harmonize public PMC names in pod #1079

rurban opened this issue Jun 15, 2014 · 2 comments
Assignees

Comments

@rurban
Copy link
Member

rurban commented Jun 15, 2014

Look at http://docs.parrot.org/parrot/6.4.0/html/pmc.html

PMC are usually found by the proper name, like AddrRegistry documented in addrregistr.pmc
However the public documentation makes it hard to find them.

Harmonize the names to at least start with the PMC without any additional desc afterwards. For the description click on it.

Like "A GC Registry PMC" => "AddrRegistry PMC"

A GC Registry PMC
Alarm
Implementation of Iterator for Arrays.
BigInt PMC class
BigNum PMC class
Boolean PMC
A byte buffer
Callback
CallContext PMC
Capture PMC
defines a class
Complex Numbers PMC Class
Continuation PMC
Co-Routine PMC
System Environment
a handler for events
Exception PMC
Exception Handler PMC
Export globals from one namespace to another
FileHandle PMC
fixed size array for booleans only
fixed size array for floating point numbers only
fixed size array for integers only
fixed size array for PMCs only
fixed size array for strings only
Floating-point number
IO Handle PMC
Hash PMC
Implementation of Iterator for Hashes.
accessor for single value during hash iteration.
ImageIOFreeze PMC
ImageIOSize PMC
ImageIOStrings PMC
ImageIOThaw PMC
A compiler object to wrap IMCC
Integer PMC class
Iterator PMC
Key PMC
LexInfo PMC
LexPad PMC
Memory-managed C struct
Mapped byte array
A container for multi-dispatched subs
NameSpace PMC
Native PCC Method PMC
Native Call Interface
NULL
An instance of a class
Opcode information
Information about an opcode library
Ordered Hash
src/pmc/orderedhashiterator.pmc
Files and Directories PMC
Packfile PMC
PackfileAnnotation PMC
PackfileAnnotations PMC
PackfileBytecodeSegment PMC
PackfileConstantTable PMC
Packfile Debug Segment PMC
PackfileDirectory PMC
Packfile Op Map PMC
PackfileRawSegment PMC
PackfileSegment PMC
PackfileView PMC
Parrot Interpreter
Dynamic Library
List of PMCs
proxy class object for a PMC enabling introspection
Pointer
Class for proxy objects used in threading
Pointer base type
PtrBuf
PtrObj
resizable array for booleans only
resizable array for floating point numbers only
resizable array for integers only
resizable array for PMCs only
resizable array for strings only
Role - defines a role
The concurrency scheduler
Scheduler messages
sockaddr_in/sockaddr_in6 holder
Socket PMC
String PMC Class
StringBuilder PMC Class
StringHandle PMC
StringIterator PMC
View pointers as C structs
Subroutine
A concurrent task
Timer
Generic undefined value
C struct with unmanaged memory
@rurban rurban self-assigned this Jun 16, 2014
rurban pushed a commit that referenced this issue Jun 16, 2014
Harmonize public PMC names in pod. Fixes GH #1079.
Also do a little bit of PMC description tuning.
@rurban
Copy link
Member Author

rurban commented Jun 16, 2014

Now the page displays:

Abstract PMCs

default PMC
Scalar PMC
PackfileSegment PMC

Core PMCs

AddrRegistry PMC
Alarm PMC
ArrayIterator PMC
BigInt PMC
BigNum PMC
Boolean PMC
ByteBuffer PMC
Callback PMC
CallContext PMC
Capture PMC
Class PMC
Complex PMC
Continuation PMC
Coroutine PMC
Env PMC
EventHandler PMC
Exception PMC
ExceptionHandler PMC
Exporter PMC
FileHandle PMC
FixedBooleanArray PMC
FixedFloatArray PMC
FixedIntegerArray PMC
FixedPMCArray PMC
FixedStringArray PMC
Float PMC
Handle PMC
Hash PMC
HashIterator PMC
HashIteratorKey PMC
ImageIOFreeze PMC
ImageIOSize PMC
ImageIOStrings PMC
ImageIOThaw PMC
IMCCompiler PMC
Integer PMC
Iterator PMC
Key PMC
LexInfo PMC
LexPad PMC
ManagedStruct PMC
MappedByteArray PMC
MultiSub PMC
NameSpace PMC
NativePCCMethod PMC
NCI PMC
Null PMC
Object PMC
Opcode PMC
OpLib PMC
OrderedHash PMC
OrderedHashIterator
OS PMC
Packfile PMC
PackfileAnnotation PMC
PackfileAnnotations PMC
PackfileBytecodeSegment PMC
PackfileConstantTable PMC
PackfileDebug PMC
PackfileDirectory PMC
PackfileOpMap PMC
PackfileRawSegment PMC
PackfileView PMC
ParrotInterpreter PMC
ParrotLibrary PMC
PMCList PMC
PMCProxy PMC
Pointer PMC
Proxy PMC
Ptr PMC
PtrBuf PMC
PtrObj PMC
ResizableBooleanArray PMC
ResizableFloatArray PMC
ResizableIntegerArray PMC
ResizablePMCArray PMC
ResizableStringArray PMC
Role PMC
Scheduler PMC
SchedulerMessage PMC
Sockaddr PMC
Socket PMC
String PMC
StringBuilder PMC
StringHandle PMC
StringIterator PMC
StructView PMC
Sub PMC
Task
Timer PMC
Undef PMC
UnManagedStruct PMC.

rurban pushed a commit that referenced this issue Jun 16, 2014
rurban pushed a commit that referenced this issue Jun 16, 2014
rurban pushed a commit that referenced this issue Jun 16, 2014
Harmonize public PMC names in pod. Fixes GH #1079.
Also do a little bit of PMC description tuning.
rurban pushed a commit that referenced this issue Jun 16, 2014
rurban pushed a commit that referenced this issue Jun 16, 2014
@rurban
Copy link
Member Author

rurban commented Jun 16, 2014

Merged with commit 948ae55
Merge: 5b4dbd1 a20044c
Author: Reini Urban rurban@cpanel.net
Date: Sun Jun 15 20:39:43 2014 -0500

Merge branch 'rurban/pmc-podnames-gh1079'

Tested ok

@rurban rurban closed this as completed Jun 16, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant