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.

Sign up for GitHub

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

Jump to bottom

<para> Note appears 4 times #16

Closed
jh-isw opened this issue Jun 19, 2023 · 4 comments
Closed

<para> Note appears 4 times #16

jh-isw opened this issue Jun 19, 2023 · 4 comments

Comments

@jh-isw
Copy link

jh-isw commented Jun 19, 2023

see this line

aas-core3.0-csharp/src/AasCore.Aas3_0/types.cs

Line 10173 in 99870fd

/// <para>

and the following
@mristin
Copy link
Contributor

mristin commented Jun 19, 2023

@jh-isw thanks for having a look! I thought that was the intended way to mark the different paragraphs?

@jh-isw
Copy link
Author

jh-isw commented Jun 20, 2023

I meant it's 4 times more or less the same content:

    /// <para>
    /// Note: categories are deprecated since V3.0 of Part 1a of the document series
    /// "Details of the Asset Administration Shell".
    /// </para>
    /// <para>
    /// Note: categories are deprecated since V3.0 of Part 1a of the document series
    /// "Details of the Asset Administration Shell".
    /// </para>
    /// <para>
    /// Categories are deprecated since V3.0 of Part 1a of the document series
    /// "Details of the Asset Administration Shell".
    /// </para>
    /// <para>
    /// Categories are deprecated since V3.0 of Part 1a of the document series
    /// "Details of the Asset Administration Shell".
    /// </para>

@mristin
Copy link
Contributor

mristin commented Jun 20, 2023

Thanks! This is an issue with indention in the docstring of aas-core-meta: https://github.com/aas-core-works/aas-core-meta/blob/2a81612dab519215621c55c8e3b434f441e5f588/aas_core_meta/v3.py#L4375. The notes should be indented one level more.

I'll try to fix this tomorrow.

mristin added a commit to aas-core-works/aas-core-meta that referenced this issue Jun 24, 2023
@mristin
Fix indention for notes in constraints
bea4ca5 
We erroneously intertwined the remarks and constraints in some of the
docstrings. Moreover, some notes were not properly indented, and were
thus parsed as remarks instead of notes referring to the respective
constraint.

This patch fixes the issue.

This is directly related to [the issue #16 in aas-core3.0-csharp].

[the issue #16 in aas-core3.0-csharp]: aas-core-works/aas-core3.0-csharp#16
@mristin mristin mentioned this issue Jun 24, 2023
Merged
mristin added a commit to aas-core-works/aas-core-meta that referenced this issue Jun 24, 2023
@mristin
Fix indention for notes in constraints (#275)
44756fb 
We erroneously intertwined the remarks and constraints in some of the
docstrings. Moreover, some notes were not properly indented, and were
thus parsed as remarks instead of notes referring to the respective
constraint.

This patch fixes the issue.

This is directly related to [the issue #16 in aas-core3.0-csharp].

[the issue #16 in aas-core3.0-csharp]: aas-core-works/aas-core3.0-csharp#16
@mristin
Copy link
Contributor

mristin commented Jun 24, 2023 •
edited
Loading

Fixed by pull request #18. Thanks again for reporting the issue, @jh-isw!

@mristin mristin closed this as completed Jun 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mristin @jh-isw