LilyPondComment

digraph InheritanceGraph { graph [bgcolor=transparent, color=lightsteelblue2, fontname=Arial, fontsize=10, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, splines=spline, style="dashed, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=10, height=0, penwidth=2, shape=box, style="filled, rounded", width=0]; edge [color=lightslategrey, penwidth=1]; subgraph "cluster_abjad.indicators" { graph [label="abjad.indicators"]; node [color=1]; "abjad.indicators.LilyPondComment.LilyPondComment" [URL="../api/abjad/indicators/LilyPondComment.html#abjad.indicators.LilyPondComment.LilyPondComment", color=black, fontcolor=white, label="Lily\nPond\nComment", target=_top]; } subgraph "cluster_abjad.system" { graph [label="abjad.system"]; node [color=2]; "abjad.system.AbjadObject.AbjadObject" [URL="../api/abjad/indicators/../system/AbjadObject.html#abjad.system.AbjadObject.AbjadObject", label="Abjad\nObject", target=_top]; "abjad.system.AbjadValueObject.AbjadValueObject" [URL="../api/abjad/indicators/../system/AbjadValueObject.html#abjad.system.AbjadValueObject.AbjadValueObject", label="Abjad\nValue\nObject", target=_top]; "abjad.system.AbjadObject.AbjadObject" -> "abjad.system.AbjadValueObject.AbjadValueObject"; } subgraph cluster_builtins { graph [label=builtins]; node [color=3]; "builtins.object" [URL="https://docs.python.org/3.6/library/functions.html#object", label=object, target=_top]; } "abjad.system.AbjadValueObject.AbjadValueObject" -> "abjad.indicators.LilyPondComment.LilyPondComment"; "builtins.object" -> "abjad.system.AbjadObject.AbjadObject"; }

class abjad.indicators.LilyPondComment.LilyPondComment(string=None, format_slot='before')

LilyPond comment.

Two-word comment:

>>> note = abjad.Note("c'4")
>>> comment = abjad.LilyPondComment('a comment')
>>> abjad.attach(comment, note)
>>> abjad.show(note) 

Three-word comment:

>>> note = abjad.Note("c'4")
>>> comment = abjad.LilyPondComment('yet another comment')
>>> abjad.attach(comment, note)
>>> abjad.show(note) 

Attributes Summary

__str__ Gets string representation of LilyPond comment.
format_slot Format slot of LilyPond comment.
list_allowable_format_slots Lists allowable format slots.
string Gets string.
tweaks Are not implemented on LilyPond comment.

Special methods

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(argument)

Is true when all initialization values of Abjad value object equal the initialization values of argument.

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to '' or 'storage'. Interprets '' equal to 'storage'.

Returns string.

(AbjadValueObject).__hash__()

Hashes Abjad value object.

Returns integer.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.

__str__()

Gets string representation of LilyPond comment.

Two-word comment:

>>> comment = abjad.LilyPondComment('a comment')
>>> str(comment)
'% a comment'

Three-word comment:

>>> comment = abjad.LilyPondComment('yet another comment')
>>> str(comment)
'% yet another comment'
Return type:str

Class & static methods

static list_allowable_format_slots()

Lists allowable format slots.

>>> commands = abjad.LilyPondComment.list_allowable_format_slots()
>>> for command in commands:
...     command
... 
'after'
'before'
'closing'
'opening'
Return type:Tuple[str, …]

Read-only properties

format_slot

Format slot of LilyPond comment.

Two-word comment:

>>> comment = abjad.LilyPondComment('a comment')
>>> comment.format_slot
'before'

Three-word comment:

>>> comment = abjad.LilyPondComment('yet another comment')
>>> comment.format_slot
'before'
Return type:str
string

Gets string.

Two-word comment:

>>> comment = abjad.LilyPondComment('a comment')
>>> comment.string
'a comment'

Three-word comment:

>>> comment = abjad.LilyPondComment('yet another comment')
>>> comment.string
'yet another comment'
Return type:str
tweaks

Are not implemented on LilyPond comment.

Return type:None