Skip to content

📝🩹 Fix missing comments in documentaion #698

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
Merged
merged 1 commit into from
Jan 24, 2024
Merged

📝🩹 Fix missing comments in documentaion #698

merged 1 commit into from
Jan 24, 2024

Conversation

@hf-krechan
Copy link
Collaborator

@hf-krechan hf-krechan commented Jan 23, 2024 •
edited
Loading

Sphinx does not recognise comments for the documentation if the variable name and the value are in different lines.

NOT GOOD

    SINGULAER_GENUTZTE_BETRIEBSMITTEL = (
        "SINGULAER_GENUTZTE_BETRIEBSMITTEL"  #: singulär genutzte Betriebsmittel (z. B. Trafomiete, Leitungen)
    )

BETTER

    #: singulär genutzte Betriebsmittel (z. B. Trafomiete, Leitungen)
    SINGULAER_GENUTZTE_BETRIEBSMITTEL = "SINGULAER_GENUTZTE_BETRIEBSMITTEL"

@hf-krechan hf-krechan requested a review from hf-kklein January 23, 2024 15:48
hf-kklein
hf-kklein approved these changes Jan 23, 2024
View reviewed changes
Copy link
Contributor

@hf-kklein hf-kklein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@hf-krechan hf-krechan merged commit a551998 into main Jan 24, 2024
@hf-krechan hf-krechan deleted the fix-docu-issue branch January 24, 2024 09:32
@lord-haffi lord-haffi mentioned this pull request Feb 6, 2024
Closed
This was referenced Feb 6, 2024
Closed
Closed
@github-actions github-actions bot mentioned this pull request Mar 10, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hf-kklein hf-kklein hf-kklein approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@hf-krechan @hf-kklein