Skip to content
This repository has been archived by the owner on Mar 25, 2019. It is now read-only.

Fix bugs on "Private/Internal/Deprecated" badges #59

Closed
wants to merge 3 commits into from
Closed

Fix bugs on "Private/Internal/Deprecated" badges #59

wants to merge 3 commits into from

Conversation

nshtg
Copy link

@nshtg nshtg commented Jul 9, 2014

Somewhere along the way modifying you forgot to adjust the exported JSON, et voilà those fancy badges (Internal, Private, Abstract) are missing. I fixed that bug and adjusted the regex at some points to allow multiple types to be used:

# Internal Abstracted Deprecated: Construct an instance representing the git repository.
#
# cwd - The {String} representing the cwd.
#
# Returns: The {GitPromised} instance.

I really really like the "Constructor" badge so I re added it, feel free to remove it again.

I can't get your grunt tests to run, jasmine version seems too outdated to start, you might want to take a look at that yourself anyways. 😉

Oh, and there is a bug in your README, quote

If you don't have one of these status indicators, Biscotto will assume the global visibility (more on this below).

Looking at the source code you make everything private by default.

hello

Oh and I have one question regarding coffeescript/js naming: Am I right when I name my methods like this:

# Internal: I'm internal, call me when you really know what you are doing!
recalculateCallCost: ->
  @callCost = @timeCalled * 0.015

# Private: You can't access me anyways
dirtyThings = ->
  "You are a bad one, aren't you?"

Or are internal and private the opposite of what I am thinking?

@nshtg nshtg changed the title Ms fix notes Fix bugs on "Private/Internal/Deprecated" badges Jul 9, 2014
Maximilian Schüßler added 3 commits July 20, 2014 16:28
The user is being informed about the 'private' status in the line
below by a red warning box already!
@nshtg
Copy link
Author

nshtg commented Jul 31, 2014

@gjtorikian
The release at npm is absolutely broke, mind unpublishing it and going back to the old version or publishing a fixed version? ;)

@gjtorikian
Copy link
Owner

@maschs I just pushed 2.2.1, let me know how that fares.

Looking into this PR now, too.

@gjtorikian
Copy link
Owner

Oh and I have one question regarding coffeescript/js naming: Am I right when I name my methods like this:

Transparently there's no real difference between Internal and Private, they're just labels I expected other people might want. For me, Private means that you can use it, but it's liable to break; Internal means you should never call it. But there's no real notion of Private in JS/CS, so you can call anything you want.

@gjtorikian
Copy link
Owner

This PR looks good to me.

If you run BISCOTTO_DEBUG=1 grunt, all the JSON spec files will autoupdate, this ensuring passing tests. Thanks!

@abe33
Copy link
Contributor

abe33 commented Aug 9, 2014

I just fetched this PR and noticed that the status blocks were no longer effective in some conditions. I couldn't figured what are theses conditions yet, but I have this repo where I have a bunch of files where it occurs, like this file, and some others like this one are parsed properly.
Basically, the methods that should have appeared as public are treated as private methods (as they are neither public nor internal).
It seems that the status property of doc object is undefined, but I could confirm that the globalScope was properly set, the comment line properly modified with a Public: string in the Parser::convertComments method but at the end the status is not found.

I'll update whenever I can find more details.

emmenko added a commit to emmenko/biscotto that referenced this pull request Mar 24, 2015
@nshtg nshtg closed this Jan 27, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants