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

Codeblocks styling in COMPUTE-ATTR #1036

Merged
merged 2 commits into from
Jun 6, 2014
Merged

Codeblocks styling in COMPUTE-ATTR #1036

merged 2 commits into from
Jun 6, 2014

Conversation

vdragsic
Copy link

@vdragsic vdragsic commented Jun 2, 2014

Fixed codeblocks styling, #1029

@daffl daffl added this to the 2.1.2 milestone Jun 3, 2014
@daffl
Copy link
Contributor

daffl commented Jun 3, 2014

Maybe we can still change the flags from

@codestart
var Person = can.Map.extend({
    fullName: function(){
        return this.attr("first") + " " + this.attr("last")
    }
})
var me = new Person({first: "Justin", last: "Meyer"})
@codeend

To tab or space indentation for this PR

    var Person = can.Map.extend({
        fullName: function(){
            return this.attr("first") + " " + this.attr("last")
        }
    })
    var me = new Person({first: "Justin", last: "Meyer"})

@booc0mtaco
Copy link
Contributor

Forgot to ask yesterday... What's wrong with @code{start | end}? Is it a change we want for convention's sake, or do those tags lead to problems elsewhere?

Related, looks like the example above uses spaces. Do we prefer spaces over tabs, vice versa, or does that not matter?

@vdragsic
Copy link
Author

vdragsic commented Jun 3, 2014

@daffl I'll update it, thanks for the tip

@daffl
Copy link
Contributor

daffl commented Jun 6, 2014

@booc0mtaco I think we should use actual markdown and not clutter it with custom tags. @param directives are a convention from documenting code and not part of any Markdown specification.

For the future I'd also like DocumentJS to also parse the YAML frontmatter for markdown files instead of having to add things like the @page and @parent tokens.

daffl added a commit that referenced this pull request Jun 6, 2014
Codeblocks styling in COMPUTE-ATTR
@daffl daffl merged commit ac1ca97 into canjs:minor Jun 6, 2014
@justinbmeyer
Copy link
Contributor

Yes, use markdown where we can.

Sent from my iPhone

On Jun 6, 2014, at 9:56 AM, David Luecke notifications@github.com wrote:

@booc0mtaco I think we should use actual markdown and not clutter it with custom tags. @param directives are a convention from documenting code and not part of any Markdown specification.

For the future I'd also like DocumentJS to also parse the YAML frontmatter for markdown files instead of having to add things like the @page and @parent tokens.


Reply to this email directly or view it on GitHub.

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.

None yet

4 participants