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

[FIX] Documentation #3231

Merged
merged 2 commits into from
Jan 30, 2024
Merged

[FIX] Documentation #3231

merged 2 commits into from
Jan 30, 2024

Conversation

eseiler
Copy link
Member

@eseiler eseiler commented Jan 30, 2024

For doxygen to work, the first line must be #... in the md files.

Even if we get the header line with grep -m1 "#" ${doc_howto_filepath} instead of head -n 1 ${doc_howto_filepath}, doxygen still needs the file to start with #, i.e., not the license header.

Luckily, the SPDX identifier doesn't have to be on the first line :)

To avoid this issue in the future, seqan3-doxygen-layout.cmake now throws a fatal error if the regex did not match.

The second commit removes \if DEV \implements ... \endif:

  • Creates a weird new line just containing a period . if DEV is FALSE.
  • \implements has no effect

@seqan-actions seqan-actions added lint [INTERNAL] signal for linting and removed lint [INTERNAL] signal for linting labels Jan 30, 2024
Copy link

vercel bot commented Jan 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
seqan3 ✅ Ready (Inspect) Visit Preview Jan 30, 2024 5:38pm

Copy link

codecov bot commented Jan 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (45897e6) 98.17% compared to head (c79a603) 98.17%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3231   +/-   ##
=======================================
  Coverage   98.17%   98.17%           
=======================================
  Files         269      269           
  Lines       11854    11854           
=======================================
  Hits        11638    11638           
  Misses        216      216           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@eseiler eseiler merged commit 521062c into seqan:main Jan 30, 2024
34 checks passed
@eseiler eseiler deleted the fix/doc branch January 30, 2024 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants