Changeset d9fa7d6 in rtems-central


Ignore:
Timestamp:
Jul 24, 2020, 6:33:04 AM (2 weeks ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
471eaef
Parents:
895ca28
git-author:
Sebastian Huber <sebastian.huber@…> (07/24/20 06:33:04)
git-committer:
Sebastian Huber <sebastian.huber@…> (07/24/20 08:02:39)
Message:

interfacedoc: Simplify interface references

Location:
rtemsspec
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • rtemsspec/interfacedoc.py

    r895ca28 rd9fa7d6  
    4747
    4848def _get_reference(name: str) -> str:
    49     return get_reference(get_label(f"{INTERFACE}{name}"), f"{name}()")
     49    return get_reference(get_label(f"{INTERFACE} {name}"))
    5050
    5151
  • rtemsspec/tests/test_interfacedoc.py

    r895ca28 rd9fa7d6  
    6464The directives provided by the Group B are:
    6565
    66 * :ref:`VeryLongFunction() <InterfaceVeryLongFunction>` - Very long function
    67   brief description.
    68 
    69 * :ref:`VeryLongTypeFunction() <InterfaceVeryLongTypeFunction>` - Function
    70   brief description with very long return type.
    71 
    72 * :ref:`VoidFunction() <InterfaceVoidFunction>`
     66* :ref:`InterfaceVeryLongFunction` - Very long function brief description.
     67
     68* :ref:`InterfaceVeryLongTypeFunction` - Function brief description with very
     69  long return type.
     70
     71* :ref:`InterfaceVoidFunction`
    7372"""
    7473        assert content == src.read()
     
    122121        is returned, in case B.
    123122
    124     Sometimes some value.  See :ref:`Function() <InterfaceFunction>`.
     123    Sometimes some value.  See :ref:`InterfaceFunction`.
    125124
    126125DESCRIPTION:
     
    178177Group A description. The directives provided by the Group A are:
    179178
    180 * :ref:`Function() <InterfaceFunction>` - Function brief description.
     179* :ref:`InterfaceFunction` - Function brief description.
    181180"""
    182181        assert content == src.read()
     
    218217
    219218DESCRIPTION:
    220     Function description.  References to :ref:`VeryLongFunction()
    221     <InterfaceVeryLongFunction>`, Integer, Enum, DEFINE, VERY_LONG_MACRO,
    222     Variable, ENUMERATOR_0, Struct, :ref:`a`, and interface.
    223 """
    224         assert content == src.read()
     219    Function description.  References to :ref:`InterfaceVeryLongFunction`,
     220    Integer, Enum, DEFINE, VERY_LONG_MACRO, Variable, ENUMERATOR_0, Struct,
     221    :ref:`a`, and interface.
     222"""
     223        assert content == src.read()
Note: See TracChangeset for help on using the changeset viewer.