ethercat icon indicating copy to clipboard operation
ethercat copied to clipboard

add documentation

Open jimy-byerley opened this issue 2 years ago • 2 comments

Hello everyone, thanks for having wrapped the etherlab kernel module !

I'm starting this PR to add rust documentation to the crate. My first motivation is to have at least some description so I can easier use that crate in a project of mine, so my documentation efforts will be driven by my specific need. The description I will write might eventually be oriented for my use when my understanding is not that good, so I will try to avoid this.

For now I only documented Master, Domain, SlaveConfig by copying the descriptions from the functions of etherlab's C library

jimy-byerley avatar Apr 12 '23 09:04 jimy-byerley

Thanks for the PR!

The issue I see here is that by copying from the GPL-licensed Etherlab implementation verbatim, we would have to relicense this crate or be in violation of the GPL.

Since I'm not a lawyer, I'm not sure how much the wording would need to differ to avoid this issue; this is the main reason #8 is still open.

birkenfeld avatar Apr 12 '23 16:04 birkenfeld

I'm not a lawyer either, but it seems we are in quite a dumb situation, there is not thousands of clear and concise ways of saying the same things. Does the license really apply on the the comments in the code ? Maybe I can tune those comments to have some different sentences than the original, but a dumb work it is :sweat:

jimy-byerley avatar Apr 12 '23 20:04 jimy-byerley