isocpp / CppCoreGuidelines

The C++ Core Guidelines are a set of tried-and-true guidelines, rules, and best practices about coding in C++

http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines

Other

42.8k stars 5.44k forks source link

the links in I: Interfaces are all broken #2210

Open janwilmans opened 4 months ago

janwilmans commented 4 months ago

https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#i-interfaces

maybe we should have CI job to check link-integrity?

cubbimew commented 4 months ago

the intra-document links are intended to be useful here: https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#S-interfaces

2198 fixes the links in github document, though we need to finish reviewing it

Lob2018 commented 1 month ago

the intra-document links are intended to be useful here: https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#S-interfaces

2198 fixes the links in github document, though we need to finish reviewing it

A Python script to automatically check that links and anchors are formatted in CppCoreGuidelines.md using GitHub Actions: github_actions_check_links_py.zip check-links-and-anchors-yml.zip With https://github.com/isocpp/CppCoreGuidelines/commit/50afe0234ce4f2f6bde7d9b0d86e926bd479f9aa modification : CppCoreGuidelines.md

Note :

Got a doubt for Rh-public l.376 : (e.g., for C.134 it is "Rh-public")
github_actions_check_links.py must be inside scripts/python/

My fork https://github.com/Lob2018/CppCoreGuidelines :
The check-link GitHub Actions workflow job works
But got error (maybe only update isocpp.dic?) with the make command (-d debug flag added) : https://github.com/Lob2018/CppCoreGuidelines/actions/runs/10847555721/job/30102865071