Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ignore scripts dir; Warn on non-doc first lines #15

Merged
merged 1 commit into from
May 15, 2023

Conversation

ZoomRmc
Copy link
Contributor

@ZoomRmc ZoomRmc commented May 13, 2023

This PR fixes the directory.nim:

  • The scripts directory is now ignored.
  • When a program tries to read the algorithm's title from the first line of source code, it now warns if this line is not a doc comment.
  • Usage is clarified a bit.

I can modify the guidelines now to require this for updating the directory.md file.

@dlesnoff
Copy link
Collaborator

I would like a modification of the guidelines (contributing.md) to specify the need to update the directory.md file with the script and I will merge this. Thanks !

@ZoomRmc
Copy link
Contributor Author

ZoomRmc commented May 14, 2023

I've started working on the guidelines, but I would like to propose some additional changes so it will require a separate PR.

@dlesnoff
Copy link
Collaborator

Fine by me!

@dlesnoff dlesnoff merged commit f1c144d into TheAlgorithms:main May 15, 2023
@ZoomRmc ZoomRmc deleted the directory_script branch September 10, 2023 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants