.. _moduleEditorial:

music21.editorial
=================

.. WARNING: DO NOT EDIT THIS FILE:
   AUTOMATICALLY GENERATED.
   PLEASE EDIT THE .py FILE DIRECTLY.

.. automodule:: music21.editorial

Editorial
---------

.. autoclass:: music21.editorial.Editorial

.. rubric:: :class:`~music21.editorial.Editorial` instance variables

.. attribute:: Editorial.comments

	
	a list of :class:`~music21.editorial.Comment` objects that represent any comments
	about the object.
	

.. attribute:: Editorial.ficta

	a :class:`~music21.pitch.Accidental` object that specifies musica
	ficta for the note.  Will only be displayed in LilyPond and then only if
	there is no Accidental object on the note itself

.. attribute:: Editorial.footnotes

	
	a list of :class:`~music21.editorial.Comment` objects that represent annotations
	for the object.
	

.. attribute:: Editorial.harmonicInterval

	an :class:`~music21.interval.Interval` object that specifies
	the harmonic interval between this note and a single other note, or None
	(useful for storing information post analysis)

.. attribute:: Editorial.melodicInterval

	an :class:`~music21.interval.Interval` object that specifies
	the melodic interval to the next note in this Part/Voice/Stream, etc.

.. attribute:: Editorial.misc

	A dict to hold anything you might like to store.

Comment
-------

.. autoclass:: music21.editorial.Comment

.. rubric:: :class:`~music21.editorial.Comment` bases

- :class:`~music21.style.StyleMixin`
- :class:`~music21.common.objects.SlottedObjectMixin`

.. rubric:: :class:`~music21.editorial.Comment` read-only properties

Read-only properties inherited from :class:`~music21.style.StyleMixin`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.StyleMixin.hasEditorialInformation`
   - :attr:`~music21.style.StyleMixin.hasStyleInformation`

.. rubric:: :class:`~music21.editorial.Comment` read/write properties

Read/write properties inherited from :class:`~music21.style.StyleMixin`:

.. hlist::
   :columns: 3

   - :attr:`~music21.style.StyleMixin.editorial`
   - :attr:`~music21.style.StyleMixin.style`
