Add search parameters for GitHub search for Cosmos
#2 528 ouverte le 26 oct. 2017
Métriques du dépôt
- Stars
- (13 462 stars)
- Métriques de merge PR
- (Aucune PR mergée en 30 j)
Description
Objective: Make GitHub search work well for searching for codes within Cosmos
Solution: Add search parameters to codes as a comment
Ideally, the search parameter should include the upper classification/ directories and the possible searchable problem statement. This must be done for all existing codes at Cosmos.
This is a simple and yet powerful enhancement can be performed by anyone in parts 👍
For instance, for the code for 2d line intersection in C at location code/computational_geometry/2d_line_intersection, the comment should be:
// computational geometry | 2D line intersecton | C
// Part of Cosmos by OpenGenus Foundation
Take a look at the C code: see
The second comment is to distinguish codes from OpenGenus and is more of a convention.
Consider this search results for 2d line intersection
For a fixed convention, we must place the search parameter comment at the top of the code
Note: new codes should take this into account