Have updated the file manual.md with the following changes:
- Removal of superfluous parentheses.
- Wrap lines, albeit occasionally.
- Stylistic changes, notably legibility and sentence structure.
- Harmonise spelling, such as Cppcheck with capital C.
Github does not work for me, in particular after 403 error.
please try github again.. it feels really inefficient to review here. But I'll try a bit..
-- Cppcheck is an analysis tool for C/C++ code.
++ Cppcheck is an analysis tool for C/C++ code that can be used prior to running the code.
Maybe we should elaborate. I am not sure.
Anyway, Cppcheck can also be used after running the code.
-- It provides unique code analysis to detect bugs and focuses on detecting undefined behaviour and dangerous coding constructs.
++ Its analysis output helps to detect bugs and undefined behaviour or even dangerous coding constructs.
I like the old better. I want to say that Cppcheck has unique analysis. It's a selling point.
Cppcheck has functional limitations, as there are many bugs that it doesn't detect. However, Cppcheck is rarely wrong about reported errors.
I would like that this is rephrazed somehow. It makes Cppcheck sound too useless. Can we write something that is more positive yet honest and transparent.
Last edit: Daniel Marjamäki 2020-11-16
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Have attached both the latest version - of which your review comments have been accommodated - as well as a colorised u-diff.
These are the commands I entered for pulling a branch and attempt to merge, with my email address obfuscated:
git clone https://github.com/danmar/cppcheck.git
cd cppcheck/
git checkout -b cppcheck_doc
git config --global user.email "technossomy@#######.com"
git commit -a -m "documentation updates"
-- entering my credentials
git push -u origin cppcheck_doc
Message:
fatal: unable to access 'https://github.com/danmar/cppcheck.git/': The requested URL returned error: 403
Ok you're almost right. You do not have write permission to my repo so you can't push anything into my repo. That is why you get a 403. You just need to fork first. If you fork cppcheck you will get your own Cppcheck repo that you have write permission in.
I have tried the instructions, but got stuck at step 2. It states "GitHub will automatically redirect you to the forked repository under your username." This is untrue, and I need to navigate to it myself. Also, there is no button “Clone or Download”.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Have updated the file manual.md with the following changes:
- Removal of superfluous parentheses.
- Wrap lines, albeit occasionally.
- Stylistic changes, notably legibility and sentence structure.
- Harmonise spelling, such as Cppcheck with capital C.
Github does not work for me, in particular after 403 error.
please try github again.. it feels really inefficient to review here. But I'll try a bit..
Maybe we should elaborate. I am not sure.
Anyway, Cppcheck can also be used after running the code.
I like the old better. I want to say that Cppcheck has unique analysis. It's a selling point.
I would like that this is rephrazed somehow. It makes Cppcheck sound too useless. Can we write something that is more positive yet honest and transparent.
Last edit: Daniel Marjamäki 2020-11-16
I think those reviews are enough for now. It would be impossible to track more .. maybe we can merge this piece by piece.
Have attached both the latest version - of which your review comments have been accommodated - as well as a colorised u-diff.
These are the commands I entered for pulling a branch and attempt to merge, with my email address obfuscated:
git clone https://github.com/danmar/cppcheck.git
cd cppcheck/
git checkout -b cppcheck_doc
git config --global user.email "technossomy@#######.com"
git commit -a -m "documentation updates"
-- entering my credentials
git push -u origin cppcheck_doc
Message:
fatal: unable to access 'https://github.com/danmar/cppcheck.git/': The requested URL returned error: 403
Ok you're almost right. You do not have write permission to my repo so you can't push anything into my repo. That is why you get a 403. You just need to fork first. If you fork cppcheck you will get your own Cppcheck repo that you have write permission in.
Hope this helps..
https://jarv.is/notes/how-to-pull-request-fork-github/
Last edit: Daniel Marjamäki 2020-11-16
I see improvements in the manual. Thanks. Well.. hope you succeed to open a PR instead.
I have tried the instructions, but got stuck at step 2. It states "GitHub will automatically redirect you to the forked repository under your username." This is untrue, and I need to navigate to it myself. Also, there is no button “Clone or Download”.
To clone you should be able to use:
Have just now performed a pull request into the github fork. Hope this helps.
good! will look at it soon. 👍