wert007 / tabelle

It is a spreadsheet program for your terminal. Written in rust.
MIT License
1 stars 1 forks source link

[Bug Report] Broken Documentation Link #10

Closed kevinmatthes closed 1 year ago

kevinmatthes commented 1 year ago

In line 132 of tabelle-core/src/cells/cell_content.rs, you attempt to link an identifier with an enum variant which does not exist (yet?). As this might cause inconvenience regarding the project's documentation, I assumed you should know about this problem.

I did not suggest a patch, yet, because I do not know whether the intended design of the concerned method would rather require an adjustment of the wording of its documentation or an implementation of the missing enum variant.

Note: there is also a shorthand syntax for linking public symbols in Rust documentation comments. For example, when implementing methods on an enum with the variant Example, you can create a hyperlink to that particular variant in the documentation comments by using the syntax shown below.

/// This method shows a different behaviour when called on [`Self::Example`].
pub fn some_method(&self) -> u8{
  if matches!(self, Self::Example) {
    42
  } else {
    0
  }
}