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

[BUG] Broken link in generated validate function comments #413

Closed
c12i opened this issue Nov 7, 2024 · 0 comments · Fixed by #411
Closed

[BUG] Broken link in generated validate function comments #413

c12i opened this issue Nov 7, 2024 · 0 comments · Fixed by #411
Labels
bug Something isn't working

Comments

@c12i
Copy link
Collaborator

c12i commented Nov 7, 2024

Describe the bug

The validate function contains a broken docs.rs URL

// You can read more about validation here: h// ocs.rs/hdi/latest/hdi/index.html#data-validation

Expected behavior

The link should be https://docs.rs/hdi/lates/hdi/index.html#data-validation

System information

  • OS: [e.g. Ubuntu 22.04, macOS 13.1]
  • Browser: [e.g. Chrome 120.0, Safari 16.3]
  • Scaffolding and Nix Version: [output from hc-scaffold --version or hc-introspect from the nix shell]

Steps to reproduce

Scaffold Web App or Example and navigate to validate function in the integrity crate's lib.rs

Additional context

The bug is as a result of replacement of all instances of // with /// and back to // which was a measure added with #382. The workaround might need to be re-worked as it can potentially lead to broken URLs inside comments in general

@c12i c12i added this to Holochain Nov 7, 2024
@github-project-automation github-project-automation bot moved this to Backlog in Holochain Nov 7, 2024
@c12i c12i moved this from Backlog to Ready for refinement in Holochain Nov 7, 2024
@c12i c12i added the bug Something isn't working label Nov 7, 2024
@c12i c12i moved this from Ready for refinement to In progress in Holochain Nov 8, 2024
@c12i c12i moved this from In progress to In review in Holochain Nov 8, 2024
@c12i c12i closed this as completed in #411 Nov 8, 2024
@github-project-automation github-project-automation bot moved this from In review to Done in Holochain Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant