Skip to content

Commit

Permalink
Add readme management into anod spec and add a test
Browse files Browse the repository at this point in the history
  • Loading branch information
leocardao committed Oct 6, 2023
1 parent 8016bdb commit df9526b
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/e3/anod/spec.py
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,17 @@ def enable_name_generator(self) -> bool:
"""
return False

@property
def readme(self) -> tuple[str, str] | None:
"""Return readme location and final filename.
.. note:: This property make sens only if a component is declared.
:return: A tuple with a relative path to spec directory where the find the
content and the final basename for the readme.
"""
return None

def declare_qualifiers_and_components(
self, qualifiers_manager: QualifiersManager
) -> None:
Expand Down

0 comments on commit df9526b

Please sign in to comment.