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

Add first NEST version a model became available to model description #1681

Closed
jougs opened this issue Jul 6, 2020 · 1 comment
Closed

Add first NEST version a model became available to model description #1681

jougs opened this issue Jul 6, 2020 · 1 comment
Assignees
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) P: Won't fix No one will work on this in the near future. See comments for details S: Normal Handle this with default priority T: Enhancement New functionality, model or documentation

Comments

@jougs
Copy link
Contributor

jougs commented Jul 6, 2020

In #1530, we removed the FirstVersion and Author fields from the model documentation because it was mostly outdated, wrong, or useless, as it only contained manually added names and missed all further contributors.

When revisiting this change during the recent hackathon, we concluded that the author information should not be in the documentation, as it can always be gotten from git log. The first version information would, however, be useful, but instead of hardcoding it into the documentation, it should rather be added automatically by the doc extractor. The algorithm for this would roughtly be the following:

  1. Check the date, when a certain model file was added to the repository
  2. Find the first major release after that date
    • if such a release exists, add the version number to the model documentation under a new Available since headline
    • else (i.e. it was already there prior to the move to git) add NEST 2.0 as version number

As the releases contain all contributing authors and the exact commit can be traced from there using the PR number, this also solves the credit assignment problem.

@jougs jougs added T: Enhancement New functionality, model or documentation S: Normal Handle this with default priority I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Jul 6, 2020
@jougs jougs added this to To do in Models via automation Jul 6, 2020
@jougs jougs added this to To do in Documentation via automation Jul 6, 2020
@heplesser heplesser added the P: Won't fix No one will work on this in the near future. See comments for details label Jun 30, 2021
@heplesser
Copy link
Contributor

Closing.

Documentation automation moved this from To do to Done Jun 30, 2021
@heplesser heplesser moved this from To do to Done in Models Nov 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) P: Won't fix No one will work on this in the near future. See comments for details S: Normal Handle this with default priority T: Enhancement New functionality, model or documentation
Projects
Documentation
  
Done
Models
  
Done
Development

No branches or pull requests

3 participants