OpenGenus/cosmos

Add search parameters for GitHub search for Cosmos

Open

#2,528 opened on Oct 26, 2017

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C++ (3,724 forks)batch import
Hacktoberfestenhancement

Repository metrics

Stars
 (13,462 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Contributor guide