DOC: shared-libraries: fix and clarify install location example #771
Conversation
There was a problem hiding this comment.
Can you also please fix the commit message to comply with the format we use for this project? Namely, it should have a summary line of less than 78 characters, starting with an identifier in all caps, DOC in this case, followed by colons and the summary of the changes. The details go in the body. Something like
DOC: shared-libraries: fix and clarify install location example
Fixes #769
|
@dnicolodi happy to fix all the above, although for the commit message wouldn't that be easier to fix when squashing the commits on merge? I guess I can fix all the above, squash the commits, and force push to the branch too but that is a bit more involved |
|
Note also that completely independent of which GitHub repo you are contributing to, you must add "fixes #XXX" in the extended description, not in the one-line summary/title. Also, use "fixes" not "fix for". Failure to obey these rules means that GitHub won't associate the fix with the issue, and the issue will not get closed when the PR is merged. |
AndrewAnnex
changed the title
You should do just that. The goal is to teach how to contribute to this project while freeing the maintainers from menial task. |
|
The CI failure is due to a bug in pygments pygments/pygments#2918 |
|
@dnicolodi sorry I had a few other things to work on but can get back to this on Friday. Maybe switching the codeblock back to python would be the quicker fix |
|
I would use |
AndrewAnnex
force-pushed
the
fix_shared_lib_doc_typo_install_dir
branch
from
5aa44a9 to
48fcf17
Compare
|
okay cleaned up the commits, updated the code-block to text, added some comments about the pygments issue, and ran precommit locally to hopefully avoid further ci complaints |
|
Thanks. |
3 participants
Updates install_path to install_dir.
Updates code block to be more explicit with shared_library usage.
Fixes #769