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

Consider consistency for the exercises #2

Open
kytrinyx opened this issue Oct 3, 2016 · 22 comments
Open

Consider consistency for the exercises #2

kytrinyx opened this issue Oct 3, 2016 · 22 comments

Comments

@kytrinyx
Copy link
Member

kytrinyx commented Oct 3, 2016

  • Is there a style guide for Delphi?
  • Are these styles encouraged or enforced?
  • Are there any conventions that we should adopt on this track for the sake of consistency?
  • Can we enforce these?
  • Is there a linter? Are there many? Should we use one?
  • Is there a common convention for filenames? If not, what should our convention be?

Note that this is about the exercises (the test suites and code examples), not people's solutions.

rpottsoh added a commit that referenced this issue Jan 10, 2017
* Exercise: saddle-points (#46)

* Config json (#48) (#2)

* Exercise: saddle-points (#46)

* Changed "Language" value

Changed it to Object Pascal from Pascal.  Curious to see if that affects
the language listing.

* implemented Ignores
rpottsoh added a commit that referenced this issue Jan 10, 2017
* Exercise: saddle-points (#46)

* Config json (#48) (#2)

* Exercise: saddle-points (#46)

* Changed "Language" value

Changed it to Object Pascal from Pascal.  Curious to see if that affects
the language listing.

* implemented Ignores
rpottsoh added a commit that referenced this issue Jan 16, 2017
* Exercise: saddle-points (#46)

* Config json (#48) (#2)

* Exercise: saddle-points (#46)

* Changed "Language" value

Changed it to Object Pascal from Pascal.  Curious to see if that affects
the language listing.

* implemented Ignores

* Resort config json (#52) (#4)

Resorted by difficulty

* Update Fork (#5)

* Resort config json (#52)

Resorted by difficulty

* Update saddle points (#51)

Removed unnecessary information

Only left a single hint that is pertinent to this exercise.

* Removed first [ignore]

First test shouldn't be ignored.
rpottsoh added a commit that referenced this issue Jan 16, 2017
* Exercise: saddle-points (#46)

* Config json (#48) (#2)

* Exercise: saddle-points (#46)

* Changed "Language" value

Changed it to Object Pascal from Pascal.  Curious to see if that affects
the language listing.

* implemented Ignores

* Resort config json (#52) (#4)

Resorted by difficulty

* Update Fork (#5)

* Resort config json (#52)

Resorted by difficulty

* Update saddle points (#51)

Removed unnecessary information

Only left a single hint that is pertinent to this exercise.

* First test was ignored

First tests shouldn't be ignored.
kotp pushed a commit that referenced this issue Jan 18, 2017
* Exercise: saddle-points (#46)

* Changed "Language" value

Changed it to Object Pascal from Pascal.  Curious to see if that affects
the language listing.
kotp pushed a commit that referenced this issue Jan 18, 2017
* Exercise: saddle-points (#46)

* Config json (#48) (#2)

* Exercise: saddle-points (#46)

* Changed "Language" value

Changed it to Object Pascal from Pascal.  Curious to see if that affects
the language listing.

* implemented Ignores

* Updated basic help information
@rpottsoh
Copy link
Member

rpottsoh commented Feb 6, 2017

Embarcadero has this style guide. This is a guide consisting of suggestions, they are not enforced by the Delphi IDE.

@rpottsoh rpottsoh closed this as completed Feb 6, 2017
@kotp
Copy link
Member

kotp commented Feb 6, 2017

Is there a linter for it, based on that guide? (Is this closed prematurely? It does not seem like the points are really answered yet.)

@rpottsoh rpottsoh reopened this Feb 6, 2017
@rpottsoh
Copy link
Member

rpottsoh commented Feb 6, 2017

I am not aware of any linter. The style guide is only a suggestion on how one should style their code. It is not enforced.

@kotp
Copy link
Member

kotp commented Feb 7, 2017

It is not enforced. Can it be set to be enforced? I don't think we should aside from the 'very strongly adopted' styles, if even that. It is something that can limit communication, at times. If so, it should be easy to communicate that the style was deviated from and disable the check for that(those) statement(s).

Should there be a link to that style guide in the documentation, for the development notes?

@rpottsoh
Copy link
Member

rpottsoh commented Feb 7, 2017 via email

@kotp
Copy link
Member

kotp commented Feb 7, 2017

Could be delivered in the first exercise, or in the documentation for the track. Perhaps mentioned in first exercise, but stored in the documentation for the track more fully.

@rpottsoh
Copy link
Member

rpottsoh commented Feb 7, 2017 via email

@kotp
Copy link
Member

kotp commented Feb 8, 2017

In the Ruby track, we use a GETTING_STARTED.md file in the exercise folder. This has instructions for the student to help get started.

@rpottsoh
Copy link
Member

rpottsoh commented Feb 8, 2017 via email

@kotp
Copy link
Member

kotp commented Feb 8, 2017

See you then!

@kytrinyx
Copy link
Member Author

Here's the documentation about exercise READMEs: https://github.com/exercism/exercism.io/blob/master/docs/fixing-exercise-readmes.md

@kotp
Copy link
Member

kotp commented Feb 12, 2017

Yes, that one, thank you very much @kytrinyx ...

@rpottsoh
Copy link
Member

I'm kind of stuck here until the revamped hello-world changes fall out. I think this discussion no longer applies to hello-world, but I am not yet sure which exercise is taking over the roll the H-W once filled. Are we getting a new exercise, perhaps a greeter or should bob pick up the reigns?

@kytrinyx
Copy link
Member Author

kytrinyx commented Feb 20, 2017

I've suggested a replacement for the old hello-world here: exercism/problem-specifications#548 I hope we can land on a spec for it in the next few days.

@kotp kotp added the pinned label Apr 5, 2017
@rpottsoh
Copy link
Member

Putting the Object Pascal Style Guide here so I can find it easier later. This document is pretty old. Will have to test all the links and remove the ones that are broken.

@rpottsoh
Copy link
Member

@kytrinyx said:

Here's the documentation about exercise READMEs: https://github.com/exercism/exercism.io/blob/master/docs/fixing-exercise-readmes.md

@kytrinyx the above link is broken. I am trying to figure out where the file has gone to (assuming /docs repo) and what the file's name is. Thanks.

@kytrinyx
Copy link
Member Author

kytrinyx commented Jul 10, 2017

@rpottsoh
Copy link
Member

No worries. Thanks @kytrinyx

@kotp
Copy link
Member

kotp commented Jul 24, 2017

In active development for formatting. Taking advantage of github support for org files.

@rpottsoh
Copy link
Member

Is there a style guide for Delphi?

http://edn.embarcadero.com/article/10280

Are these styles encouraged or enforced?

Encouraged by the style guide, yes. Enforced by the IDE, no.

Are there any conventions that we should adopt on this track for the sake of consistency?

A recent development that I have decided to adopt is to not use inline variable declarations or type inference in test suites. This capability has only become possible in the latest version of Delphi released at the end of 2018. Any code written using these new language features will not compile in older versions of Delphi. I am not enforcing this rule on solutions or examples.

Can we enforce these?

Manually, yes.

Is there a linter? Are there many? Should we use one?

I am not aware of any linter.

Is there a common convention for filenames? If not, what should our convention be?

No common naming convention other than files containing code have .pas extension. Files that contain UI information have .dfm extension.

This quickly covers the points raised in the first comment.

@kytrinyx
Copy link
Member Author

It sounds like the most useful next step here, then, would be to document in the README or contributing file the conventions that are in place, and then not worry about automation.

@rpottsoh
Copy link
Member

It sounds like the most useful next step here, then, would be to document in the README or contributing file the conventions that are in place,

I agree. I have ignored the README for this repo.

@github-actions github-actions bot removed the pinned label Jun 4, 2021
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

No branches or pull requests

3 participants