@@ -325,7 +325,7 @@ def create_post(self, path, content=None, onefile=False, is_page=False, **kw):
325
325
raise NotImplementedError ()
326
326
327
327
def extension (self ):
328
- """The preferred extension for the output of this compiler."""
328
+ """Return the preferred extension for the output of this compiler."""
329
329
return ".html"
330
330
331
331
def read_metadata (self , post , file_metadata_regexp = None , unslugify_titles = False , lang = None ):
@@ -690,9 +690,10 @@ def get_classification_friendly_name(self, classification, lang, only_last_compo
690
690
raise NotImplementedError ()
691
691
692
692
def get_overview_path (self , lang , dest_type = 'page' ):
693
- """A path handler for the classification overview.
693
+ """Return path for classification overview.
694
694
695
- Must return one or two values (in this order):
695
+ This path handler for the classification overview must return one or
696
+ two values (in this order):
696
697
* a list or tuple of strings: the path relative to OUTPUT_DIRECTORY;
697
698
* a string with values 'auto', 'always' or 'never', indicating whether
698
699
INDEX_FILE should be added or not.
@@ -710,9 +711,10 @@ def get_overview_path(self, lang, dest_type='page'):
710
711
raise NotImplementedError ()
711
712
712
713
def get_path (self , classification , lang , dest_type = 'page' ):
713
- """A path handler for the given classification.
714
+ """Return path to the classification page .
714
715
715
- Must return one to three values (in this order):
716
+ This path handler for the given classification must return one to
717
+ three values (in this order):
716
718
* a list or tuple of strings: the path relative to OUTPUT_DIRECTORY;
717
719
* a string with values 'auto', 'always' or 'never', indicating whether
718
720
INDEX_FILE should be added or not;
0 commit comments