Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@Laymer
Copy link
Contributor

@Laymer Laymer commented Aug 24, 2019

Hello :)

In answer to #59 , I have added a subset of the tutorial in the pmod_nav module description as a first basis, and the link to the Wiki tutorial πŸ™‚

Hope this helps,

Best,

Igor

@eproxus
Copy link
Member

eproxus commented Aug 26, 2019

Hi!

I think this documentation copies a little bit too much from the tutorial. Better would be if the module documentation focused on the various function and operations available. Linking to the tutorial is good, but we don't need to replicate any warnings, how to even use drivers in general etc.

Some minor comments:

  • The original comments should stay, because they link to the actual chip specifications. These are comments intended for developers working with this module
  • Remove any extra spaces everywhere (before colons, inside HTML elements etc.)
  • The module is usually referred to as PmodNAV so it's better to stick to that for consistency

I would explain the high level model of the module (the different components) and the basic functions available (read, write etc.). And don't write anything in the module documentation that should go into the individual function documentation sections.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants