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

Add link from EOG Pass to Specs #1813

Merged
merged 11 commits into from
Nov 18, 2024
Merged

Add link from EOG Pass to Specs #1813

merged 11 commits into from
Nov 18, 2024

Conversation

KuechA
Copy link
Contributor

@KuechA KuechA commented Nov 5, 2024

Closes #1760

Copy link

codecov bot commented Nov 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.13%. Comparing base (3fe8edb) to head (5f59e92).
Report is 1 commits behind head on main.

Additional details and impacted files
Files with missing lines Coverage Δ
...hofer/aisec/cpg/passes/EvaluationOrderGraphPass.kt 89.53% <100.00%> (-0.07%) ⬇️

... and 1 file with indirect coverage changes

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

@KuechA KuechA marked this pull request as ready for review November 5, 2024 17:40
@KuechA KuechA requested a review from maximiliankaul November 5, 2024 17:40
Copy link
Collaborator

@konradweiss konradweiss left a comment

Choose a reason for hiding this comment

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

Add one general link to the specification in the class doc of the pass together with a reminder for future developers to extend the documentation.

One additional thing that we "could" change, but this is more a usability remark, is to change the individual link texts to "-Specification" instead of simply "Specification" to make it clearer that they lead to different parts of the specification.

@oxisto oxisto enabled auto-merge (squash) November 18, 2024 11:47
@oxisto oxisto merged commit c98539c into main Nov 18, 2024
3 checks passed
@oxisto oxisto deleted the eog-docs branch November 18, 2024 11:52
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.

Provide link to EOG specification in each handler function of the EOG
3 participants