Fix/rustdoc warnings#2045

[krishnakurtakoti]

Fixes issues/2045

[krishnakurtakoti]

Made suggested changes. Please check.

[thomas-zahner]

Thank you for applying my suggestions, all changes look good now. However, in the current state the PR does not fix the mentioned issue so there are still things to do.

• Fix all rustdoc warnings (cargo doc --no-deps still yields warnings)
• Remove continue-on-error: true in linting step
• CI doesn't pass, test failures need to be addressed

As a side-note I feel like the current PR description doesn't really help. It's really verbose and contains repeated content from my contents as well as confusing parts (e.g. Rule of Thumb) that seem to come from a LLM. Maybe you could shorten the description to the essential parts, or just leave the first line.

[thomas-zahner]

@katrinafyi now addressed the comment I referenced previously with caa7d5c. Consequently I've updated my above comment.

I recommend you to now rebase this PR on master, so that you can test the changes with this new commit included. You can then remove the line with continue-on-error: true and update the name of the step. Next you should address all warnings/errors which you can now see in the CI step.

[mre]

@krishnakurtakoti, can you rebase this branch on top of master?