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

Improve documentation for developers #116

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

n9iels
Copy link
Contributor

@n9iels n9iels commented Jun 23, 2020

This PR is an attempt to improve the documentation for developers in how to create a FLINT data model. The planning is that it will contain a basic overview of a model and a more in depth overview of all available expressions that can be used.

doc/FLINT models.md Outdated Show resolved Hide resolved
doc/FLINT models.md Outdated Show resolved Hide resolved

1) model : datastructure that defines a process closely tied to official law and regulation texts, and which is expressed as related actions in which an actor attends to a need for an object expressed by another actor as interested party and can solve this need by denoting the action as been taken which is only possible if the preconditions are met. It defines at least the following attributes
### Model
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would be good with removing some stuff here and linking the document you wrote above. They largely have the same content right?

@n9iels n9iels force-pushed the docs/improve-documentation branch 3 times, most recently from c0421d9 to 20dbdb2 Compare June 29, 2020 06:37
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities (and Security Hotspot 0 Security Hotspots to review)
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@n9iels n9iels marked this pull request as ready for review July 6, 2020 13:26
@n9iels n9iels mentioned this pull request Jul 6, 2020
@n9iels n9iels force-pushed the docs/improve-documentation branch from dda3db8 to 3a1ef50 Compare August 5, 2020 06:15
@sonarqubecloud
Copy link

sonarqubecloud bot commented Aug 5, 2020

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities (and Security Hotspot 0 Security Hotspots to review)
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

Copy link
Contributor

@pimotte pimotte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if you would want to merge this yet, I think it's ready, with the one comment and the caveat that PROJECTION is not on master yet.

{
"acts": [
{
// Act that creates the '[aanvraag]' fact
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these to be filled in? If not, using jsonc as highlighting should render them nicely

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a typo here. used the retrieve

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.

3 participants