Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[orchestra2md] Actor and Flow documentation content is added before the Markdown heading #71

Open
JThoennes opened this issue Oct 13, 2022 · 3 comments
Labels
bug Something isn't working

Comments

@JThoennes
Copy link

    <fixr:actors>
        <fixr:actor name="TradingAdapter">
            <fixr:annotation>
                <fixr:documentation contentType="text/markdown">This actor connects the BLOXX Order Management to the Trading System of the customer.</fixr:documentation>
            </fixr:annotation>
        </fixr:actor>
        <fixr:actor name="TradingSystem">
            <fixr:annotation>
                <fixr:documentation contentType="text/markdown">This is the customers Trading System receiving orders from the Trading Adapter and sending executions back.</fixr:documentation>
            </fixr:annotation>
        </fixr:actor>
    </fixr:actors>

is rendered in Markdown as:

## Actors and Flows

This actor connects the BLOXX Order Management to the Trading System of the customer.

### Actor TradingAdapter

This is the customers Trading System receiving orders from the Trading Adapter and sending executions back.

### Actor TradingSystem

It seems the fixr:documentation contents is added before the related heading.

@JThoennes JThoennes changed the title [md2orchestra] Actor documentation content is added before the Markdown heading [md2orchestra] Actor and Flow documentation content is added before the Markdown heading Oct 13, 2022
@JThoennes
Copy link
Author

The same applies to the documentation element of a fixr:flow element.

@donmendelson donmendelson changed the title [md2orchestra] Actor and Flow documentation content is added before the Markdown heading [orchestra2md] Actor and Flow documentation content is added before the Markdown heading Oct 14, 2022
@donmendelson donmendelson added the bug Something isn't working label Oct 14, 2022
@JThoennes
Copy link
Author

JThoennes commented Oct 14, 2022

@donmendelson Just tested it locally. Now the headings appear twice in the Markdown (content meanwhile change a bit...):

## Actors and Flows

### Actor ClientOrderSender

This actor resembles the BLOXX FIX Trading Adapter in Client Order mode. It connects the BLOXX Order Management to the Trading System of the customer.

### Actor ClientOrderSender

### Actor BlockOrderSender

This actor resembles the BLOXX FIX Trading Adapter in Block Order mode. It connects the BLOXX Order Management to the Trading System of the customer.

### Actor BlockOrderSender

### Actor TradingSystem

Thanks for the prompt commit!

JThoennes pushed a commit to JThoennes/tablature that referenced this issue Oct 14, 2022
donmendelson added a commit that referenced this issue Oct 14, 2022
JThoennes pushed a commit to JThoennes/tablature that referenced this issue Oct 17, 2022
@JThoennes
Copy link
Author

@donmendelson I think my second PR solves this issue. But a test is missing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: No status
Development

No branches or pull requests

2 participants