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

Link or include important discussions in design documents #10

Open
awvwgk opened this issue Nov 29, 2021 · 0 comments
Open

Link or include important discussions in design documents #10

awvwgk opened this issue Nov 29, 2021 · 0 comments
Labels
section: design Related to the design section

Comments

@awvwgk
Copy link
Member

awvwgk commented Nov 29, 2021

@Beliavsky wrote in https://fortran-lang.discourse.group/t/2338/5:

A fifth part could be added: discussions . Most code in stdlib has one or more related issues where it has been discussed. If related discussions were listed for each source file, that would help to fill in the reference information, since people have often provided links to references when discussing algorithms. Reading discussions could also tell users why algorithms were chosen and what the alternatives are.

@certik wrote in https://fortran-lang.discourse.group/t/2338/7:

Excellent idea. Indeed, we should link all discussions for each module in stdlib. I think the discussions are usually related to the whole module, not just a single file.

It’s the same idea behind the GitHub - j3-fortran/fortran_proposals: Proposals for the Fortran Standard Committee repository: to be able to track discussions behind each Fortran feature as it is added to the standard, and features that didn’t make it (and why).

We should include or reference important issues from the design documents or even the reference as appropriate. Let's use this issue to collect important issues and discussions from the fpm repository which should be mentioned in the fpm design documents.

@awvwgk awvwgk added the section: design Related to the design section label Nov 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
section: design Related to the design section
Projects
None yet
Development

No branches or pull requests

1 participant