Adding advance example and documentation #3
Conversation
Travis tests have failedHey @sanujkul, TravisBuddy Request Identifier: 7a7b5c50-6070-11ea-afc8-ddb27bdee665 |
|
Can someone please help me in understanding why I have failed this check and what has to be done? |
Travis tests have failedHey @sanujkul, TravisBuddy Request Identifier: b14261b0-6071-11ea-afc8-ddb27bdee665 |
The check is for a specific formatting standard, which your code doesn't match.
In this case, you can resolve the problem by doing a Tools > Auto Format on I know it's confusing that the Arduino IDE automatically adds these |
There was a problem hiding this comment.
Your numbering goes:
1.
2.
2.
3.
I don't see any benefit to having these numbers. As we can see here, they make the documentation more difficult to maintain. So I suggest just removing them.
You established a convention of documenting the return type in the Debug.setDebugLevel(int const debug_level) documentation, then abandoned that convention in the rest of the documentation. I think it is good to document return types, so I would suggest you add this documentation to the rest.
Co-Authored-By: per1234 <accounts@perglass.com>
Co-Authored-By: per1234 <accounts@perglass.com>
Co-Authored-By: per1234 <accounts@perglass.com>
Co-Authored-By: per1234 <accounts@perglass.com>
Travis tests have failedHey @sanujkul, TravisBuddy Request Identifier: de0169e0-611a-11ea-b333-4fa8171c3056 |
Correcting spelling of Arduino in comments Co-Authored-By: per1234 <accounts@perglass.com>
Co-Authored-By: per1234 <accounts@perglass.com>
Travis tests have failedHey @sanujkul, TravisBuddy Request Identifier: 02e33f40-611b-11ea-b333-4fa8171c3056 |
Travis tests have failedHey @sanujkul, TravisBuddy Request Identifier: 22d90280-611b-11ea-b333-4fa8171c3056 |
Adding a linebreak Co-Authored-By: per1234 <accounts@perglass.com>
Adding one more linebreak Co-Authored-By: per1234 <accounts@perglass.com>
Travis tests have failedHey @sanujkul, TravisBuddy Request Identifier: 477b36d0-611b-11ea-b333-4fa8171c3056 |
Travis tests have failedHey @sanujkul, TravisBuddy Request Identifier: 6c085c80-611b-11ea-b333-4fa8171c3056 |
Travis tests have failedHey @sanujkul, TravisBuddy Request Identifier: f5186790-611b-11ea-b333-4fa8171c3056 |
|
@per1234 . Thank you! I have committed your suggestions and also modified Readme.md to remove numbering and added Return type and Example to all member functions. But still it is failing travis test! |
|
@per1234 . Thank you very much for your suggestions. I did auto-formatting and it worked! :) |
Adding an advance example that can make use of software serial as old Arduino boards only have one Serial and thus using your library with SoftwareSerial output Stream will give lots of flexibility.
Adding documentation as it will help the users to know how to use this library and what all ways are there.