search

mvanthoor / rustic

Rustic is a chess engine. It is written from scratch in the Rust programming language.
https://rustic-chess.org/
GNU General Public License v3.0
134 stars 7 forks source link

Fixed some typos i found reading through the documentation and comments. #48

Closed Nereuxofficial closed 3 years ago

Nereuxofficial commented 3 years ago

While reading through the code i found some typos in the documentation and took the liberty to fix them

mvanthoor commented 3 years ago

Thanks :) Wanted to do this for some time. Looks good :)

Nereuxofficial commented 3 years ago

A thing i noticed though was that you do extensive comments over functions but don't use the documentation comments(As shown here). The documentation for the project can then automatically be generated via cargo doc --open. May i fix that or would that be unnecessary since you write the documentation another way?

mvanthoor commented 3 years ago

@Nereuxofficial

Hi,

Thanks for the offer of updating all the comments. That is not necessary however; it would take even more space than the comments are already taking up now. They are just quick explanations / summarizations of the documentation / book I'm writing here:

https://rustic-chess.org/

This is far from complete, obviously, but in the run-up to version 3.0.0, this site had quite a large update as well. In the end, all the information about the engine will be there; not in technical detail down to the last byte, but it will contain how each function/feature works, with some sample code taken from the engine. (When a feature changes extensively, I'll probably update the sample code as well.)

Kind regards, Marcel